@datafire/azure_resources NPM

@datafire/azure_resources

Client library for ResourceManagementClient

Installation and Usage

npm install --save @datafire/azure_resources

let azure_resources = require('@datafire/azure_resources').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Provides operations for working with resources and resource groups.

Actions

Providers_ListAtTenantScope

Gets all resource providers for the tenant.

azure_resources.Providers_ListAtTenantScope({
  "api-version": ""
}, context)

Input

input object
- $top integer: The number of results to return. If null is passed returns all providers.
- $expand string: The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.
- api-version required string: The API version to use for this operation.

Output

output ProviderListResult

Deployments_ListAtManagementGroupScope

Get all the deployments for a management group.

azure_resources.Deployments_ListAtManagementGroupScope({
  "groupId": "",
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- $filter string: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
- $top integer: The number of results to get. If null is passed, returns all deployments.
- api-version required string: The API version to use for this operation.

Output

output DeploymentListResult

Deployments_DeleteAtManagementGroupScope

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

azure_resources.Deployments_DeleteAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_GetAtManagementGroupScope

Gets a deployment.

azure_resources.Deployments_GetAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

output DeploymentExtended

Deployments_CheckExistenceAtManagementGroupScope

Checks whether the deployment exists.

azure_resources.Deployments_CheckExistenceAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_CreateOrUpdateAtManagementGroupScope

You can provide the template and parameters directly in the request or link to JSON files.

azure_resources.Deployments_CreateOrUpdateAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- parameters required ScopedDeployment
- api-version required string: The API version to use for this operation.

Output

output DeploymentExtended

Deployments_CancelAtManagementGroupScope

You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.

azure_resources.Deployments_CancelAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_ExportTemplateAtManagementGroupScope

Exports the template used for specified deployment.

azure_resources.Deployments_ExportTemplateAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

output DeploymentExportResult

DeploymentOperations_ListAtManagementGroupScope

Gets all deployments operations for a deployment.

azure_resources.DeploymentOperations_ListAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- $top integer: The number of results to return.
- api-version required string: The API version to use for this operation.

Output

output DeploymentOperationsListResult

DeploymentOperations_GetAtManagementGroupScope

Gets a deployments operation.

azure_resources.DeploymentOperations_GetAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "operationId": "",
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- operationId required string: The ID of the operation to get.
- api-version required string: The API version to use for this operation.

Output

output DeploymentOperation

Deployments_ValidateAtManagementGroupScope

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

azure_resources.Deployments_ValidateAtManagementGroupScope({
  "groupId": "",
  "deploymentName": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- groupId required string: The management group ID.
- deploymentName required string: The name of the deployment.
- parameters required ScopedDeployment
- api-version required string: The API version to use for this operation.

Output

output DeploymentValidateResult

Deployments_CalculateTemplateHash

Calculate the hash of the given template.

azure_resources.Deployments_CalculateTemplateHash({
  "api-version": "",
  "template": {}
}, context)

Input

input object
- api-version required string: The API version to use for this operation.
- template required object

Output

output TemplateHashResult

Deployments_ListAtTenantScope

Get all the deployments at the tenant scope.

azure_resources.Deployments_ListAtTenantScope({
  "api-version": ""
}, context)

Input

input object
- $filter string: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
- $top integer: The number of results to get. If null is passed, returns all deployments.
- api-version required string: The API version to use for this operation.

Output

output DeploymentListResult

Deployments_DeleteAtTenantScope

azure_resources.Deployments_DeleteAtTenantScope({
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_GetAtTenantScope

Gets a deployment.

azure_resources.Deployments_GetAtTenantScope({
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

output DeploymentExtended

Deployments_CheckExistenceAtTenantScope

Checks whether the deployment exists.

azure_resources.Deployments_CheckExistenceAtTenantScope({
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_CreateOrUpdateAtTenantScope

You can provide the template and parameters directly in the request or link to JSON files.

azure_resources.Deployments_CreateOrUpdateAtTenantScope({
  "deploymentName": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- parameters required ScopedDeployment
- api-version required string: The API version to use for this operation.

Output

output DeploymentExtended

Deployments_CancelAtTenantScope

azure_resources.Deployments_CancelAtTenantScope({
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_ExportTemplateAtTenantScope

Exports the template used for specified deployment.

azure_resources.Deployments_ExportTemplateAtTenantScope({
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

output DeploymentExportResult

DeploymentOperations_ListAtTenantScope

Gets all deployments operations for a deployment.

azure_resources.DeploymentOperations_ListAtTenantScope({
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- $top integer: The number of results to return.
- api-version required string: The API version to use for this operation.

Output

output DeploymentOperationsListResult

DeploymentOperations_GetAtTenantScope

Gets a deployments operation.

azure_resources.DeploymentOperations_GetAtTenantScope({
  "deploymentName": "",
  "operationId": "",
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- operationId required string: The ID of the operation to get.
- api-version required string: The API version to use for this operation.

Output

output DeploymentOperation

Deployments_ValidateAtTenantScope

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

azure_resources.Deployments_ValidateAtTenantScope({
  "deploymentName": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- parameters required ScopedDeployment
- api-version required string: The API version to use for this operation.

Output

output DeploymentValidateResult

Operations_List

Lists all of the available Microsoft.Resources REST API operations.

azure_resources.Operations_List({
  "api-version": ""
}, context)

Input

input object
- api-version required string: The API version to use for this operation.

Output

output OperationListResult

Providers_GetAtTenantScope

Gets the specified resource provider at the tenant level.

azure_resources.Providers_GetAtTenantScope({
  "resourceProviderNamespace": "",
  "api-version": ""
}, context)

Input

input object
- $expand string: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.
- resourceProviderNamespace required string: The namespace of the resource provider.
- api-version required string: The API version to use for this operation.

Output

output Provider

Providers_List

Gets all resource providers for a subscription.

azure_resources.Providers_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- $top integer: The number of results to return. If null is passed returns all deployments.
- $expand string: The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output ProviderListResult

Deployments_ListAtSubscriptionScope

Get all the deployments for a subscription.

azure_resources.Deployments_ListAtSubscriptionScope({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- $filter string: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
- $top integer: The number of results to get. If null is passed, returns all deployments.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentListResult

Deployments_DeleteAtSubscriptionScope

azure_resources.Deployments_DeleteAtSubscriptionScope({
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Deployments_GetAtSubscriptionScope

Gets a deployment.

azure_resources.Deployments_GetAtSubscriptionScope({
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentExtended

Deployments_CheckExistenceAtSubscriptionScope

Checks whether the deployment exists.

azure_resources.Deployments_CheckExistenceAtSubscriptionScope({
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Deployments_CreateOrUpdateAtSubscriptionScope

You can provide the template and parameters directly in the request or link to JSON files.

azure_resources.Deployments_CreateOrUpdateAtSubscriptionScope({
  "deploymentName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- parameters required Deployment
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentExtended

Deployments_CancelAtSubscriptionScope

azure_resources.Deployments_CancelAtSubscriptionScope({
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Deployments_ExportTemplateAtSubscriptionScope

Exports the template used for specified deployment.

azure_resources.Deployments_ExportTemplateAtSubscriptionScope({
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentExportResult

DeploymentOperations_ListAtSubscriptionScope

Gets all deployments operations for a deployment.

azure_resources.DeploymentOperations_ListAtSubscriptionScope({
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- $top integer: The number of results to return.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentOperationsListResult

DeploymentOperations_GetAtSubscriptionScope

Gets a deployments operation.

azure_resources.DeploymentOperations_GetAtSubscriptionScope({
  "deploymentName": "",
  "operationId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- operationId required string: The ID of the operation to get.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentOperation

Deployments_ValidateAtSubscriptionScope

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

azure_resources.Deployments_ValidateAtSubscriptionScope({
  "deploymentName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- parameters required Deployment
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentValidateResult

Deployments_WhatIfAtSubscriptionScope

Returns changes that will be made by the deployment if executed at the scope of the subscription.

azure_resources.Deployments_WhatIfAtSubscriptionScope({
  "deploymentName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- deploymentName required string: The name of the deployment.
- parameters required DeploymentWhatIf
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output WhatIfOperationResult

Providers_Get

Gets the specified resource provider.

azure_resources.Providers_Get({
  "resourceProviderNamespace": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- $expand string: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.
- resourceProviderNamespace required string: The namespace of the resource provider.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output Provider

Providers_Register

Registers a subscription with a resource provider.

azure_resources.Providers_Register({
  "resourceProviderNamespace": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceProviderNamespace required string: The namespace of the resource provider to register.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output Provider

Providers_Unregister

Unregisters a subscription from a resource provider.

azure_resources.Providers_Unregister({
  "resourceProviderNamespace": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceProviderNamespace required string: The namespace of the resource provider to unregister.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output Provider

Resources_ListByResourceGroup

Get all the resources for a resource group.

azure_resources.Resources_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The resource group with the resources to get.
- $filter string: The filter to apply on the operation.The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)You can link more than one substringof together by adding and/or operators.You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId.
- $expand string: The $expand query parameter. You can expand createdTime and changedTime. For example, to expand both properties, use $expand=changedTime,createdTime
- $top integer: The number of results to return. If null is passed, returns all resources.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output ResourceListResult

Resources_MoveResources

The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.

azure_resources.Resources_MoveResources({
  "sourceResourceGroupName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- sourceResourceGroupName required string: The name of the resource group containing the resources to move.
- parameters required ResourcesMoveInfo
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Resources_ValidateMoveResources

This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.

azure_resources.Resources_ValidateMoveResources({
  "sourceResourceGroupName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- sourceResourceGroupName required string: The name of the resource group containing the resources to validate for move.
- parameters required ResourcesMoveInfo
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

ResourceGroups_List

Gets all the resource groups for a subscription.

azure_resources.ResourceGroups_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- $filter string: The filter to apply on the operation.You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'
- $top integer: The number of results to return. If null is passed, returns all resource groups.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output ResourceGroupListResult

ResourceGroups_Delete

When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

azure_resources.ResourceGroups_Delete({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group to delete. The name is case insensitive.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

ResourceGroups_Get

Gets a resource group.

azure_resources.ResourceGroups_Get({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group to get. The name is case insensitive.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output ResourceGroup

ResourceGroups_CheckExistence

Checks whether a resource group exists.

azure_resources.ResourceGroups_CheckExistence({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group to check. The name is case insensitive.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

ResourceGroups_Update

Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

azure_resources.ResourceGroups_Update({
  "resourceGroupName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group to update. The name is case insensitive.
- parameters required ResourceGroupPatchable
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output ResourceGroup

ResourceGroups_CreateOrUpdate

Creates or updates a resource group.

azure_resources.ResourceGroups_CreateOrUpdate({
  "resourceGroupName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
- parameters required ResourceGroup
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output ResourceGroup

DeploymentOperations_List

Gets all deployments operations for a deployment.

azure_resources.DeploymentOperations_List({
  "resourceGroupName": "",
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- $top integer: The number of results to return.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentOperationsListResult

DeploymentOperations_Get

Gets a deployments operation.

azure_resources.DeploymentOperations_Get({
  "resourceGroupName": "",
  "deploymentName": "",
  "operationId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- operationId required string: The ID of the operation to get.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentOperation

ResourceGroups_ExportTemplate

Captures the specified resource group as a template.

azure_resources.ResourceGroups_ExportTemplate({
  "subscriptionId": "",
  "resourceGroupName": "",
  "api-version": "",
  "parameters": null
}, context)

Input

input object
- subscriptionId required string: The ID of the target subscription.
- resourceGroupName required string: The name of the resource group. The name is case insensitive.
- api-version required string: The API version to use for this operation.
- parameters required ExportTemplateRequest

Output

output ResourceGroupExportResult

Deployments_ListByResourceGroup

Get all the deployments for a resource group.

azure_resources.Deployments_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group with the deployments to get. The name is case insensitive.
- $filter string: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
- $top integer: The number of results to get. If null is passed, returns all deployments.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentListResult

Deployments_Delete

A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.

azure_resources.Deployments_Delete({
  "resourceGroupName": "",
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group with the deployment to delete. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Deployments_Get

Gets a deployment.

azure_resources.Deployments_Get({
  "resourceGroupName": "",
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentExtended

Deployments_CheckExistence

Checks whether the deployment exists.

azure_resources.Deployments_CheckExistence({
  "resourceGroupName": "",
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group with the deployment to check. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Deployments_CreateOrUpdate

You can provide the template and parameters directly in the request or link to JSON files.

azure_resources.Deployments_CreateOrUpdate({
  "resourceGroupName": "",
  "deploymentName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.
- deploymentName required string: The name of the deployment.
- parameters required Deployment
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentExtended

Deployments_Cancel

azure_resources.Deployments_Cancel({
  "resourceGroupName": "",
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Deployments_ExportTemplate

Exports the template used for specified deployment.

azure_resources.Deployments_ExportTemplate({
  "resourceGroupName": "",
  "deploymentName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentExportResult

Deployments_Validate

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

azure_resources.Deployments_Validate({
  "resourceGroupName": "",
  "deploymentName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group the template will be deployed to. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- parameters required Deployment
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output DeploymentValidateResult

Deployments_WhatIf

Returns changes that will be made by the deployment if executed at the scope of the resource group.

azure_resources.Deployments_WhatIf({
  "resourceGroupName": "",
  "deploymentName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group the template will be deployed to. The name is case insensitive.
- deploymentName required string: The name of the deployment.
- parameters required DeploymentWhatIf
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output WhatIfOperationResult

Resources_Delete

Deletes a resource.

azure_resources.Resources_Delete({
  "resourceGroupName": "",
  "resourceProviderNamespace": "",
  "parentResourcePath": "",
  "resourceType": "",
  "resourceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group that contains the resource to delete. The name is case insensitive.
- resourceProviderNamespace required string: The namespace of the resource provider.
- parentResourcePath required string: The parent resource identity.
- resourceType required string: The resource type.
- resourceName required string: The name of the resource to delete.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Resources_Get

Gets a resource.

azure_resources.Resources_Get({
  "resourceGroupName": "",
  "resourceProviderNamespace": "",
  "parentResourcePath": "",
  "resourceType": "",
  "resourceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group containing the resource to get. The name is case insensitive.
- resourceProviderNamespace required string: The namespace of the resource provider.
- parentResourcePath required string: The parent resource identity.
- resourceType required string: The resource type of the resource.
- resourceName required string: The name of the resource to get.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output GenericResource

Resources_CheckExistence

Checks whether a resource exists.

azure_resources.Resources_CheckExistence({
  "resourceGroupName": "",
  "resourceProviderNamespace": "",
  "parentResourcePath": "",
  "resourceType": "",
  "resourceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group containing the resource to check. The name is case insensitive.
- resourceProviderNamespace required string: The resource provider of the resource to check.
- parentResourcePath required string: The parent resource identity.
- resourceType required string: The resource type.
- resourceName required string: The name of the resource to check whether it exists.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Resources_Update

Updates a resource.

azure_resources.Resources_Update({
  "resourceGroupName": "",
  "resourceProviderNamespace": "",
  "parentResourcePath": "",
  "resourceType": "",
  "resourceName": "",
  "api-version": "",
  "parameters": null,
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group for the resource. The name is case insensitive.
- resourceProviderNamespace required string: The namespace of the resource provider.
- parentResourcePath required string: The parent resource identity.
- resourceType required string: The resource type of the resource to update.
- resourceName required string: The name of the resource to update.
- api-version required string: The API version to use for this operation.
- parameters required GenericResource
- subscriptionId required string: The ID of the target subscription.

Output

output GenericResource

Resources_CreateOrUpdate

Creates a resource.

azure_resources.Resources_CreateOrUpdate({
  "resourceGroupName": "",
  "resourceProviderNamespace": "",
  "parentResourcePath": "",
  "resourceType": "",
  "resourceName": "",
  "api-version": "",
  "parameters": null,
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group for the resource. The name is case insensitive.
- resourceProviderNamespace required string: The namespace of the resource provider.
- parentResourcePath required string: The parent resource identity.
- resourceType required string: The resource type of the resource to create.
- resourceName required string: The name of the resource to create.
- api-version required string: The API version to use for this operation.
- parameters required GenericResource
- subscriptionId required string: The ID of the target subscription.

Output

output GenericResource

Resources_List

Get all the resources in a subscription.

azure_resources.Resources_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- $filter string: The filter to apply on the operation.The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)You can link more than one substringof together by adding and/or operators.You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId.
- $expand string: The $expand query parameter. You can expand createdTime and changedTime. For example, to expand both properties, use $expand=changedTime,createdTime
- $top integer: The number of results to return. If null is passed, returns all resource groups.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output ResourceListResult

Tags_List

Gets the names and values of all resource tags that are defined in a subscription.

azure_resources.Tags_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output TagsListResult

Tags_Delete

You must remove all values from a resource tag before you can delete it.

azure_resources.Tags_Delete({
  "tagName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- tagName required string: The name of the tag.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Tags_CreateOrUpdate

The tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You cannot create tags with one of these prefixes.

azure_resources.Tags_CreateOrUpdate({
  "tagName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- tagName required string: The name of the tag to create.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output TagDetails

Tags_DeleteValue

Deletes a tag value.

azure_resources.Tags_DeleteValue({
  "tagName": "",
  "tagValue": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- tagName required string: The name of the tag.
- tagValue required string: The value of the tag to delete.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

Output schema unknown

Tags_CreateOrUpdateValue

Creates a tag value. The name of the tag must already exist.

azure_resources.Tags_CreateOrUpdateValue({
  "tagName": "",
  "tagValue": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- tagName required string: The name of the tag.
- tagValue required string: The value of the tag to create.
- api-version required string: The API version to use for this operation.
- subscriptionId required string: The ID of the target subscription.

Output

output TagValue

Resources_DeleteById

Deletes a resource by ID.

azure_resources.Resources_DeleteById({
  "resourceId": "",
  "api-version": ""
}, context)

Input

input object
- resourceId required string: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Resources_GetById

Gets a resource by ID.

azure_resources.Resources_GetById({
  "resourceId": "",
  "api-version": ""
}, context)

Input

input object
- resourceId required string: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
- api-version required string: The API version to use for this operation.

Output

output GenericResource

Resources_CheckExistenceById

Checks by ID whether a resource exists.

azure_resources.Resources_CheckExistenceById({
  "resourceId": "",
  "api-version": ""
}, context)

Input

input object
- resourceId required string: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Resources_UpdateById

Updates a resource by ID.

azure_resources.Resources_UpdateById({
  "resourceId": "",
  "api-version": "",
  "parameters": null
}, context)

Input

input object
- resourceId required string: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
- api-version required string: The API version to use for this operation.
- parameters required GenericResource

Output

output GenericResource

Resources_CreateOrUpdateById

Create a resource by ID.

azure_resources.Resources_CreateOrUpdateById({
  "resourceId": "",
  "api-version": "",
  "parameters": null
}, context)

Input

input object
- resourceId required string: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}
- api-version required string: The API version to use for this operation.
- parameters required GenericResource

Output

output GenericResource

Deployments_ListAtScope

Get all the deployments at the given scope.

azure_resources.Deployments_ListAtScope({
  "scope": "",
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- $filter string: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.
- $top integer: The number of results to get. If null is passed, returns all deployments.
- api-version required string: The API version to use for this operation.

Output

output DeploymentListResult

Deployments_DeleteAtScope

azure_resources.Deployments_DeleteAtScope({
  "scope": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_GetAtScope

Gets a deployment.

azure_resources.Deployments_GetAtScope({
  "scope": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

output DeploymentExtended

Deployments_CheckExistenceAtScope

Checks whether the deployment exists.

azure_resources.Deployments_CheckExistenceAtScope({
  "scope": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_CreateOrUpdateAtScope

You can provide the template and parameters directly in the request or link to JSON files.

azure_resources.Deployments_CreateOrUpdateAtScope({
  "scope": "",
  "deploymentName": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- parameters required Deployment
- api-version required string: The API version to use for this operation.

Output

output DeploymentExtended

Deployments_CancelAtScope

azure_resources.Deployments_CancelAtScope({
  "scope": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

Output schema unknown

Deployments_ExportTemplateAtScope

Exports the template used for specified deployment.

azure_resources.Deployments_ExportTemplateAtScope({
  "scope": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- api-version required string: The API version to use for this operation.

Output

output DeploymentExportResult

DeploymentOperations_ListAtScope

Gets all deployments operations for a deployment.

azure_resources.DeploymentOperations_ListAtScope({
  "scope": "",
  "deploymentName": "",
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- $top integer: The number of results to return.
- api-version required string: The API version to use for this operation.

Output

output DeploymentOperationsListResult

DeploymentOperations_GetAtScope

Gets a deployments operation.

azure_resources.DeploymentOperations_GetAtScope({
  "scope": "",
  "deploymentName": "",
  "operationId": "",
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- operationId required string: The ID of the operation to get.
- api-version required string: The API version to use for this operation.

Output

output DeploymentOperation

Deployments_ValidateAtScope

Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

azure_resources.Deployments_ValidateAtScope({
  "scope": "",
  "deploymentName": "",
  "parameters": null,
  "api-version": ""
}, context)

Input

input object
- scope required string: The scope of a deployment.
- deploymentName required string: The name of the deployment.
- parameters required Deployment
- api-version required string: The API version to use for this operation.

Output

output DeploymentValidateResult

Definitions

AliasPathType

AliasPathType object: The type of the paths for alias.
- apiVersions array: The API versions.
  - items string
- path string: The path of an alias.

AliasType

AliasType object: The alias type.
- name string: The alias name.
- paths array: The paths for an alias.
  - items AliasPathType

BasicDependency

BasicDependency object: Deployment dependency information.
- id string: The ID of the dependency.
- resourceName string: The dependency resource name.
- resourceType string: The dependency resource type.

CloudError

CloudError object: An error response for a resource management request.
- error object: The resource management error response.
  - additionalInfo array: The error additional info.
    - items object: The resource management error additional info.
      - info object: The additional info.
      - type string: The additional info type.
  - code string: The error code.
  - details array: The error details.
    - items ErrorResponse
  - message string: The error message.
  - target string: The error target.

DebugSetting

DebugSetting object: The debug setting.
- detailLevel string: Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.

Dependency

Dependency object: Deployment dependency information.
- dependsOn array: The list of dependencies.
  - items BasicDependency
- id string: The ID of the dependency.
- resourceName string: The dependency resource name.
- resourceType string: The dependency resource type.

Deployment

Deployment object: Deployment operation parameters.
- location string: The location to store the deployment data.
- properties required DeploymentProperties

DeploymentExportResult

DeploymentExportResult object: The deployment export result.
- template object: The template content.

DeploymentExtended

DeploymentExtended object: Deployment information.
- id string: The ID of the deployment.
- location string: the location of the deployment.
- name string: The name of the deployment.
- properties DeploymentPropertiesExtended
- type string: The type of the deployment.

DeploymentExtendedFilter

DeploymentExtendedFilter object: Deployment filter.
- provisioningState string: The provisioning state.

DeploymentListResult

DeploymentListResult object: List of deployments.
- nextLink `stri

datafire

@infinitebrahmanuniverse/nolb-_datafire_az @everything-registry/sub-chunk-221

5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago