Connectors Reference
Azure Resource Manager exposes the APIs to manage all of your Azure resources.
|
Status: Preview |
Tier: Premium |
Version: 2016-06-01 |
|
Name |
Summary |
|
Subscriptions_ListLocations (string subscriptionId, [internal]string x-ms-api-version) |
Lists the subscription locations |
|
Subscriptions_Get ([internal]string x-ms-api-version, string subscriptionId) |
Read a subscription |
|
List subscriptions |
|
|
Reads an async operation (internal) |
|
|
Read a template deployment |
|
|
Create or update a template deployment |
|
|
Delete template deployment |
|
|
Cancel a template deployment |
|
|
Validate a template deployment |
|
|
Export deployment template |
|
|
List template deployments |
|
|
Read a template deployment operation |
|
|
Lists template deployment operations |
|
|
Unregister resource provider |
|
|
Register resource provider |
|
|
List resource providers |
|
|
Read resource provider |
|
|
List resources by resource group |
|
|
Read a resource group |
|
|
Create or update a resource group |
|
|
Delete a resource group |
|
|
Update an existing resource group |
|
|
Export a resource group template |
|
|
List resource groups |
|
|
List resources by subscription |
|
|
Read a resource |
|
|
Create or update a resource |
|
|
Delete a resource |
|
|
Invoke resource operation |
|
|
Read a resource in provider |
|
|
Invoke resource operation in provider |
|
|
Create or update a subscription resource tag value |
|
|
Delete a subscription resource tag value |
|
|
Tags_CreateOrUpdate (string subscriptionId, string tagName, [internal]string x-ms-api-version) |
Create or update a subscription resource tag name |
|
Tags_Delete (string subscriptionId, string tagName, [internal]string x-ms-api-version) |
Delete a subscription resource tag name |
|
Tags_List (string subscriptionId, [internal]string x-ms-api-version) |
List subscription resource tags |
|
Get operation status |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Action response |
|
|
|
|
|
Identity |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Response |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Action response |
|
|
SKU |
|
|
|
|
|
|
|
|
Subscription Policies |
|
|
Tag Count |
|
|
|
|
|
|
|
|
|
|
|
Target Resource |
|
|
|
Summary: Lists the subscription locations
Description: Lists the locations available for the subscription.
Syntax:
AzureResourceManager.Subscriptions_ListLocations (string subscriptionId, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:LocationListResult
Description: Location list operation response.
Summary: Read a subscription
Description: Reads the details for a particular subscription.
Syntax:
AzureResourceManager.Subscriptions_Get ([internal]string x-ms-api-version, string subscriptionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
|
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
Returns:
Type:Subscription
Description: Subscription information.
Summary: List subscriptions
Description: Gets a list of all the subscriptions to which the principal has access.
Syntax:
AzureResourceManager.Subscriptions_List ([internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Description: Subscription list operation response.
Summary: Reads an async operation (internal)
Description: Reads an async operation (internal).
Syntax:
AzureResourceManager.AsyncOperations_Get (string subscriptionId, string operationResult, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
operationResult |
string
|
The operation result Id. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:AsyncOperations_GetResponse
Description: Async operations response.
Summary: Read a template deployment
Description: Reads a template deployment within a resource group.
Syntax:
AzureResourceManager.Deployments_Get (string subscriptionId, string resourceGroupName, string deploymentName, [internal]string x-ms-api-version, [Optional]boolean wait)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
deploymentName |
string (Deployment Name) |
The name of the resource group template deployment. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
|
|
wait |
boolean (Wait for Deployment) |
If the action should wait until deployment is completed |
False |
Returns:
Type:DeploymentExtended
Description: Deployment information.
Summary: Create or update a template deployment
Description: Create or update a named resource group template deployment. A template and parameters are expected for the request to succeed.
Syntax:
AzureResourceManager.Deployments_CreateOrUpdate (string subscriptionId, string resourceGroupName, string deploymentName, Deployment parameters, [internal]string x-ms-api-version, [Optional]boolean wait)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
deploymentName |
string (Deployment Name) |
The name of the deployment. |
True |
|
|
parameters |
|
Deployment operation parameters. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
|
|
wait |
boolean (Wait for Deployment) |
If the action should wait until deployment is completed |
False |
Returns:
Type:DeploymentExtended
Description: Deployment information.
Summary: Delete template deployment
Description: Deletes a resource group template deployment. The resources will not be deleted; only the metadata about the template deployment.
Syntax:
AzureResourceManager.Deployments_Delete (string subscriptionId, string resourceGroupName, string deploymentName, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
deploymentName |
string (Deployment Name) |
The name of the resource group template deployment. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Summary: Cancel a template deployment
Description: Cancel a currently running template deployment. All pending template operations will be suspended.
Syntax:
AzureResourceManager.Deployments_Cancel (string subscriptionId, string resourceGroupName, string deploymentName, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
deploymentName |
string (Deployment Name) |
The name of the resource group template deployment. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Summary: Validate a template deployment
Description: Validates a deployment template. This operation does not have side effects and can be used to test a template deployment for syntax or logical errors.
Syntax:
AzureResourceManager.Deployments_Validate (string subscriptionId, string resourceGroupName, string deploymentName, Deployment parameters, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
deploymentName |
string (Deployment Name) |
The name of the resource group template deployment. |
True |
|
|
parameters |
|
Deployment operation parameters. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Description: Information from validate template deployment response.
Summary: Export deployment template
Description: Exports a template from a past resource group deployment.
Syntax:
AzureResourceManager.Deployments_ExportTemplate (string subscriptionId, string resourceGroupName, string deploymentName, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
deploymentName |
string (Deployment Name) |
The name of the resource group template deployment. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Description: The deployment export result.
Summary: List template deployments
Description: Lists all the resource group template deployments. This operation is useful to know what has been provisioned thus far.
Syntax:
AzureResourceManager.Deployments_List (string subscriptionId, string resourceGroupName, [advanced][Optional]string $filter, [advanced][Optional]integer $top, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
$filter |
string (Filter) |
The filter to apply on the operation. |
False |
|
|
$top |
integer(int32) (Top) |
Query parameters. If nothing is passed returns all values. |
False |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:DeploymentListResult
Description: List of deployments.
Summary: Read a template deployment operation
Description: Reads a particular resource group template deployment operation. This is useful for troubleshooting failed template deployments.
Syntax:
AzureResourceManager.DeploymentOperations_Get (string subscriptionId, string resourceGroupName, string deploymentName, string operationId, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
deploymentName |
string (Deployment Name) |
The name of the resource group template deployment. |
True |
|
|
operationId |
string (Operation Id) |
Operation Id. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:DeploymentOperation
Description: Deployment operation information.
Summary: Lists template deployment operations
Description: Lists all the template deployment operations. This is useful for troubleshooting failed template deployments.
Syntax:
AzureResourceManager.DeploymentOperations_List (string subscriptionId, string resourceGroupName, string deploymentName, [advanced][Optional]integer $top, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
deploymentName |
string (Deployment Name) |
The name of the resource group template deployment. |
True |
|
|
$top |
integer(int32) (Top) |
Query parameters. If nothing is passed returns all values. |
False |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:DeploymentOperationsListResult
Description: List of deployment operations.
Summary: Unregister resource provider
Description: Unregisters provider from a subscription. This operation will fail if there are any resources from that resource provider in the subscription.
Syntax:
AzureResourceManager.Providers_Unregister (string subscriptionId, string resourceProviderNamespace, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:Provider
Description: Resource provider information.
Summary: Register resource provider
Description: Registers a resource provider to be used with a subscription. This will provision permissions for the service into your subscription.
Syntax:
AzureResourceManager.Providers_Register (string subscriptionId, string resourceProviderNamespace, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:Provider
Description: Resource provider information.
Summary: List resource providers
Description: Lists the resource providers available for the subscription.
Syntax:
AzureResourceManager.Providers_List (string subscriptionId, [advanced][Optional]integer $top, [advanced][Optional]string $expand, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
$top |
integer(int32) (Top) |
Query parameters. If nothing is passed returns all values. |
False |
|
|
$expand |
string (Expand) |
The $expand query parameter. |
False |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:ProviderListResult
Description: List of resource providers.
Summary: Read resource provider
Description: Reads a particular resource provider within the subscription.
Syntax:
AzureResourceManager.Providers_Get (string subscriptionId, string resourceProviderNamespace, [advanced][Optional]string $expand, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
$expand |
string (Expand) |
The $expand query parameter. |
False |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:Provider
Description: Resource provider information.
Summary: List resources by resource group
Description: Lists all the resources under a resource group.
Syntax:
AzureResourceManager.ResourceGroups_ListResources ([internal]string x-ms-api-version, string subscriptionId, string resourceGroupName, [advanced][Optional]string $filter, [advanced][Optional]string $expand, [advanced][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
|
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
$filter |
string (Filter) |
The filter to apply on the operation. |
False |
|
|
$expand |
string (Expand) |
The $expand query parameter. |
False |
|
|
$top |
integer(int32) (Top) |
Query parameters. If nothing is passed returns all values. |
False |
Returns:
Type:ResourceListResult
Description: List of resources.
Summary: Read a resource group
Description: Reads a particular resource group within the subscription.
Syntax:
AzureResourceManager.ResourceGroups_Get (string subscriptionId, string resourceGroupName, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:ResourceGroup
Description: Resource group information.
Summary: Create or update a resource group
Description: Creates or updates a resource group. The response code can be used to distinguish between a create (201) or update (200).
Syntax:
AzureResourceManager.ResourceGroups_CreateOrUpdate (string subscriptionId, string resourceGroupName, ResourceGroup parameters, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group Name) |
The name of the resource group to be created or updated. |
True |
|
|
parameters |
|
Resource group information. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:ResourceGroup
Description: Resource group information.
Summary: Delete a resource group
Description: Delete a particular resource group within the subscription.
Syntax:
AzureResourceManager.ResourceGroups_Delete (string subscriptionId, string resourceGroupName, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Summary: Update an existing resource group
Description: Updates an existing resource group. If the resource does not exist, this request will fail.
Syntax:
AzureResourceManager.ResourceGroups_Patch (string subscriptionId, string resourceGroupName, ResourceGroup parameters, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
parameters |
|
Resource group information. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:ResourceGroup
Description: Resource group information.
Summary: Export a resource group template
Description: Exports a deployment template from an existing resource group. This can only be successful if the underlying resources have a schema defined by Microsoft.
Syntax:
AzureResourceManager.ResourceGroups_ExportTemplate (string subscriptionId, string resourceGroupName, ExportTemplateRequest parameters, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
parameters |
|
Export resource group template request parameters. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:ResourceGroupExportResult
Summary: List resource groups
Description: Lists all the resource groups within the subscription. The results are paginated at 1,000+ records.
Syntax:
AzureResourceManager.ResourceGroups_List ([internal]string x-ms-api-version, string subscriptionId, [advanced][Optional]string $filter, [advanced][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
|
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
$filter |
string (Filter) |
The filter to apply on the operation. |
False |
|
|
$top |
integer(int32) (Top) |
Query parameters. If nothing is passed returns all values. |
False |
Returns:
Description: List of resource groups.
Summary: List resources by subscription
Description: Reads all of the resources under a particular subscription. The results are paginated at 1,000+ records.
Syntax:
AzureResourceManager.Resources_List (string subscriptionId, [advanced][Optional]string $filter, [advanced][Optional]string $expand, [advanced][Optional]integer $top, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
$filter |
string (Filter) |
The filter to apply on the operation. |
False |
|
|
$expand |
string (Expand) |
The $expand query parameter. |
False |
|
|
$top |
integer(int32) (Top) |
Query parameters. If nothing is passed returns all values. |
False |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:ResourceListResult
Description: List of resources.
Summary: Read a resource
Description: Reads a resource object.
Syntax:
AzureResourceManager.Resources_GetById (string subscriptionId, string resourceGroupName, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
shortResourceId |
string (Short Resource Id) |
The short Id of the resource, including the resource name and resource type. For example, sites/mySite |
True |
|
|
x-ms-api-version |
string (Client Api Version) |
Api Version to be used. |
True |
Returns:
Type:GenericResource
Description: Resource information.
Summary: Create or update a resource
Description: Creates or updates a resource. The response code can be used to distinguish between a create (201) or update (200).
Syntax:
AzureResourceManager.Resources_CreateOrUpdateById (string subscriptionId, string resourceGroupName, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version, GenericResource parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
shortResourceId |
string (Short Resource Id) |
The short Id of the resource, including the resource name and resource type. For example, sites/mySite |
True |
|
|
x-ms-api-version |
string (Client Api Version) |
Api Version to be used. |
True |
|
|
parameters |
|
Resource information. |
True |
Returns:
Type:GenericResource
Description: Resource information.
Summary: Delete a resource
Description: Deletes a resource.
Syntax:
AzureResourceManager.Resources_DeleteById (string subscriptionId, string resourceGroupName, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
shortResourceId |
string (Short Resource Id) |
The short Id of the resource, including the resource name and resource type. For example, sites/mySite |
True |
|
|
x-ms-api-version |
string (Client Api Version) |
Api Version to be used. |
True |
Returns:
Summary: Invoke resource operation
Description: Invokes an operation on an Azure resource.
Syntax:
AzureResourceManager.Resources_Invoke (string subscriptionId, string resourceGroupName, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version, string actionName, [Optional]Resources_InvokeParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceGroupName |
string (Resource Group) |
Resource group name. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
shortResourceId |
string (Short Resource Id) |
The short Id of the resource, including the resource name and resource type. For example, sites/mySite |
True |
|
|
x-ms-api-version |
string (Client Api Version) |
Api Version to be used. |
True |
|
|
actionName |
string (Action name) |
Name of the resource action to invoke |
True |
|
|
body |
|
|
False |
Returns:
Summary: Action response
Description: The response from the action operation.
Summary: Read a resource in provider
Description: Reads a resource object.
Syntax:
AzureResourceManager.Provider_Resources_GetById (string subscriptionId, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
shortResourceId |
string (Short Resource Id) |
The short Id of the resource, including the resource name and resource type. For example, sites/mySite |
True |
|
|
x-ms-api-version |
string (Client Api Version) |
Api Version to be used. |
True |
Returns:
Type:GenericResource
Description: Resource information.
Summary: Invoke resource operation in provider
Description: Invokes an operation on an Azure resource.
Syntax:
AzureResourceManager.Provider_Resources_Invoke (string subscriptionId, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version, [Optional]Provider_Resources_InvokeParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
resourceProviderNamespace |
string (Resource Provider) |
Namespace of the resource provider. |
True |
|
|
shortResourceId |
string (Short Resource Id) |
The short Id of the resource, including the resource name and resource type. For example, sites/mySite |
True |
|
|
x-ms-api-version |
string (Client Api Version) |
Api Version to be used. |
True |
|
|
body |
Provider_Resources_InvokeParameterBody
|
|
False |
Returns:
Type:Provider_Resources_InvokeResponse
Summary: Response
Description: The response from the operation.
Summary: Create or update a subscription resource tag value
Description: Create or update a subscription resource tag value.
Syntax:
AzureResourceManager.Tags_CreateOrUpdateValue (string subscriptionId, string tagName, string tagValue, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
tagName |
string (Tag Name) |
The name of the tag. |
True |
|
|
tagValue |
string (Tag Value) |
The value of the tag. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:TagValue
Description: Tag information.
Summary: Delete a subscription resource tag value
Description: Delete a subscription resource tag value.
Syntax:
AzureResourceManager.Tags_DeleteValue (string subscriptionId, string tagName, string tagValue, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
tagName |
string (Tag Name) |
The name of the tag. |
True |
|
|
tagValue |
string (Tag Value) |
The value of the tag. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Summary: Create or update a subscription resource tag name
Description: Create or update a subscription resource tag name.
Syntax:
AzureResourceManager.Tags_CreateOrUpdate (string subscriptionId, string tagName, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
tagName |
string (Tag Name) |
The name of the tag. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:TagDetails
Description: Tag details.
Summary: Delete a subscription resource tag name
Description: Delete a subscription resource tag name.
Syntax:
AzureResourceManager.Tags_Delete (string subscriptionId, string tagName, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
tagName |
string (Tag Name) |
The name of the tag. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Summary: List subscription resource tags
Description: Lists all the subscription resource tags.
Syntax:
AzureResourceManager.Tags_List (string subscriptionId, [internal]string x-ms-api-version)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscriptionId |
string (Subscription) |
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
True |
|
|
x-ms-api-version |
string Values: [2016-06-01] |
Client Api Version. |
True |
Returns:
Type:TagsListResult
Description: List of subscription tags.
Summary: Get operation status
Description: Gets status of async operation from provided url.
Syntax:
AzureResourceManager.GetAsyncStatus (string url)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
url |
string(url) (Url to get operation status) |
Url which is used to get operation status. |
True |
Returns:
Summary: Action response
Description: The response from the redirect operation.
Summary:
Description: The type of the paths for alias.
Properties:
|
Name |
Type |
Summary |
|
path |
string
|
The path of an alias. |
|
apiVersions |
array of (string)
|
The api versions. |
Summary:
Description: The alias type.
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The alias name. |
|
paths |
array of (AliasPathType)
|
The paths for an alias. |
Summary:
Description: Async operations response.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Deployment dependency information.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
The ID of the dependency. |
|
resourceType |
string
|
The dependency resource type. |
|
resourceName |
string
|
The dependency resource name. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
detailLevel |
string Detail Level |
The debug detail level. |
Summary:
Description: Deployment dependency information.
Properties:
|
Name |
Type |
Summary |
|
dependsOn |
array of (BasicDependency)
|
The list of dependencies. |
|
id |
string
|
The ID of the dependency. |
|
resourceType |
string
|
The dependency resource type. |
|
resourceName |
string
|
The dependency resource name. |
Summary:
Description: Deployment operation parameters.
Properties:
|
Name |
Type |
Summary |
|
properties |
|
Deployment properties. |
Summary:
Description: The deployment export result.
Properties:
|
Name |
Type |
Summary |
|
template |
Template |
The template content. |
Summary: Template
Description: The template content.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Deployment information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The ID of the deployment. |
|
name |
string Name |
The name of the deployment. |
|
properties |
|
Deployment properties with additional details. |
Summary:
Description: List of deployments.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (DeploymentExtended)
|
The list of deployments. |
|
nextLink |
string Next Link |
The URL to get the next set of results. |
Summary:
Description: Deployment operation information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Full deployment operation id. |
|
operationId |
string Operation Id |
Deployment operation id. |
|
properties |
|
Deployment operation properties. |
Summary:
Description: Deployment operation properties.
Properties:
|
Name |
Type |
Summary |
|
provisioningState |
string
|
The state of the provisioning. |
|
timestamp |
string(date-time)
|
The date and time of the operation. |
|
serviceRequestId |
string
|
Deployment operation service request id. |
|
statusCode |
string
|
Operation status code. |
|
statusMessage |
|
Operation status message. |
|
targetResource |
Target Resource |
Target resource. |
|
request |
|
|
|
response |
|
|
Summary:
Description: Operation status message.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: List of deployment operations.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (DeploymentOperation)
|
The list of deployments. |
|
nextLink |
string Next Link |
The URL to get the next set of results. |
Summary:
Description: Deployment properties.
Properties:
|
Name |
Type |
Summary |
|
template |
Template Content |
The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink. |
|
templateLink |
|
Entity representing the reference to the template. |
|
parameters |
Parameters |
Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink. |
|
parametersLink |
|
Entity representing the reference to the deployment paramaters. |
|
mode |
string Deployment Mode |
The deployment mode. Values: [Incremental, Complete] |
|
debugSetting |
|
|
Summary: Template Content
Description: The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink.
Properties:
|
Name |
Type |
Summary |
Summary: Parameters
Description: Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Deployment properties with additional details.
Properties:
|
Name |
Type |
Summary |
|
provisioningState |
string
|
The state of the provisioning. |
|
correlationId |
string
|
The correlation ID of the deployment. |
|
timestamp |
string(date-time)
|
The timestamp of the template deployment. |
|
outputs |
|
Key/value pairs that represent deploymentoutput. |
|
providers |
array of (Provider)
|
The list of resource providers needed for the deployment. |
|
dependencies |
array of (Dependency)
|
The list of deployment dependencies. |
|
template |
|
The template content. Use only one of Template or TemplateLink. |
|
templateLink |
|
Entity representing the reference to the template. |
|
parameters |
|
Deployment parameters. Use only one of Parameters or ParametersLink. |
|
parametersLink |
|
Entity representing the reference to the deployment paramaters. |
|
mode |
string Deployment Mode |
The deployment mode. Values: [Incremental, Complete] |
|
debugSetting |
|
|
Summary:
Description: Key/value pairs that represent deploymentoutput.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: The template content. Use only one of Template or TemplateLink.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Deployment parameters. Use only one of Parameters or ParametersLink.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Information from validate template deployment response.
Properties:
|
Name |
Type |
Summary |
|
error |
ResourceManagementErrorWithDetails
|
|
|
properties |
|
Deployment properties with additional details. |
Summary:
Description: Export resource group template request parameters.
Properties:
|
Name |
Type |
Summary |
|
resources |
array of (string)
|
The ids of the resources. The only supported string currently is '*' (all resources). Future api updates will support exporting specific resources. |
|
options |
string
|
The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments Values: [IncludeParameterDefaultValue, IncludeComments, IncludeParameterDefaultValue, IncludeComments] |
Summary:
Description: Resource information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Resource Id |
|
name |
string Name |
Resource name |
|
type |
string Type |
Resource type |
|
location |
string Location |
Resource location |
|
tags |
Tags |
Resource tags |
|
plan |
|
Plan for the resource. |
|
kind |
string Kind |
The kind of the resource. |
|
managedBy |
string Managed By |
Id of the resource that manages this resource. |
|
sku |
SKU |
Sku for the resource. |
|
identity |
Identity |
Identity for the resource. |
|
properties |
Properties |
The resource properties. |
Summary: Tags
Description: Resource tags
Properties:
|
Name |
Type |
Summary |
Summary: Properties
Description: The resource properties.
Properties:
|
Name |
Type |
Summary |
Summary: Action response
Description: The response from the redirect operation.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
content |
|
HTTP message content. |
Summary:
Description: HTTP message content.
Properties:
|
Name |
Type |
Summary |
Summary: Identity
Description: Identity for the resource.
Properties:
|
Name |
Type |
Summary |
|
principalId |
string Principal Id |
The principal id of resource identity. |
|
tenantId |
string Tenant Id |
The tenant id of resource. |
|
type |
string Type |
The identity type. Values: [SystemAssigned] |
Summary:
Description: Location information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The fully qualified Id of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus. |
|
subscriptionId |
string Subscription Id |
The subscription Id. |
|
name |
string Location Name |
The location name. |
|
displayName |
string Display Name |
The display name of the location. |
|
latitude |
string Latitude |
The latitude of the location. |
|
longitude |
string Longitude |
The longitude of the location. |
Summary:
Description: Location list operation response.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Location)
|
The locations. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Entity representing the reference to the deployment paramaters.
Properties:
|
Name |
Type |
Summary |
|
uri |
string Parameters URI |
URI referencing the template. |
|
contentVersion |
string Parameters Content Version |
If included it must match the ContentVersion in the template. |
Summary:
Description: Plan for the resource.
Properties:
|
Name |
Type |
Summary |
|
name |
string Id |
The plan ID. |
|
publisher |
string Publisher |
The publisher ID. |
|
product |
string Product |
The offer ID. |
|
promotionCode |
string Promotion Code |
The promotion code. |
Summary:
Description: Resource provider information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The provider id. |
|
namespace |
string Namespace |
The namespace of the provider. |
|
registrationState |
string Registration State |
The registration state of the provider. |
|
resourceTypes |
array of (ProviderResourceType) Resource Type |
The collection of provider resource types. |
Summary:
Description: List of resource providers.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Provider)
|
The list of resource providers. |
|
nextLink |
string
|
The URL to get the next set of results. |
Summary:
Description: Resource type managed by the resource provider.
Properties:
|
Name |
Type |
Summary |
|
resourceType |
string
|
The resource type. |
|
locations |
array of (ObjectWithoutType)
|
The collection of locations where this resource type can be created in. |
|
aliases |
array of (AliasType)
|
The aliases that are supported by this resource type. |
|
apiVersions |
array of (string)
|
The api version. |
|
properties |
|
The properties. |
Summary:
Description: The properties.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Response
Description: The response from the operation.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Resource group information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY). |
|
name |
string Name |
The Name of the resource group. |
|
location |
string Location |
The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. |
|
managedBy |
string Managed By |
Id of the resource that manages this resource group. |
|
tags |
Tags |
The tags attached to the resource group. |
|
properties |
|
The resource group properties. |
Summary: Tags
Description: The tags attached to the resource group.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
template |
Template |
The template content. |
|
error |
ResourceManagementErrorWithDetails
|
|
Summary: Template
Description: The template content.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: List of resource groups.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ResourceGroup)
|
The list of resource groups. |
|
nextLink |
string Next Link |
The URL to get the next set of results. |
Summary:
Description: The resource group properties.
Properties:
|
Name |
Type |
Summary |
|
provisioningState |
string Provisioning State |
The provisioning state. |
Summary:
Description: List of resources.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (GenericResource)
|
The list of resources. |
|
nextLink |
string Next Link |
The URL to get the next set of results. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
code |
string
|
The error code returned from the server. |
|
message |
string
|
The error message returned from the server. |
|
target |
string
|
The target of the error. |
|
details |
array of (DetailsItem)
|
Validation error. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Action response
Description: The response from the action operation.
Properties:
|
Name |
Type |
Summary |
Summary: SKU
Description: Sku for the resource.
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
The sku name. |
|
tier |
string Tier |
The sku tier. |
|
size |
string Size |
The sku size. |
|
family |
string Family |
The sku family. |
|
model |
string Model |
The sku model. |
|
capacity |
integer(int32) Capacity |
The sku capacity. |
Summary:
Description: Subscription information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000. |
|
subscriptionId |
string Subscription Id |
The subscription Id. |
|
tenantId |
string Tenant Id |
The tenant Id. |
|
displayName |
string Display Name |
The subscription display name. |
|
state |
string State |
The subscription state. Values: [Enabled, Warned, PastDue, Disabled, Deleted] |
|
subscriptionPolicies |
Subscription Policies |
Subscription policies. |
|
authorizationSource |
string Authorization Source |
The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'. |
Summary:
Description: Subscription list operation response.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Subscription)
|
The subscriptions. |
|
nextLink |
string Next Link |
The URL to get the next set of results. |
Summary: Subscription Policies
Description: Subscription policies.
Properties:
|
Name |
Type |
Summary |
|
locationPlacementId |
string Location Placement Id |
The subscription location placement Id. The Id indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions. |
|
quotaId |
string Quota Id |
The subscription quota Id. |
|
spendingLimit |
string Spending Limit |
The subscription spending limit. Values: [On, Off, CurrentPeriodOff] |
Summary: Tag Count
Description: Tag count.
Properties:
|
Name |
Type |
Summary |
|
type |
string Type |
Type of count. |
|
value |
integer Value |
Value of count. |
Summary:
Description: Tag details.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The tag ID. |
|
tagName |
string Name |
The tag name. |
|
count |
Tag Count |
Tag count. |
|
values |
array of (TagValue)
|
The list of tag values. |
Summary:
Description: List of subscription tags.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (TagDetails)
|
The list of tags. |
|
nextLink |
string
|
The URL to get the next set of results. |
Summary:
Description: Tag information.
Properties:
|
Name |
Type |
Summary |
|
id |
string Tag Id |
The tag ID. |
|
tagValue |
string Tag Value |
The tag value. |
|
count |
Tag Count |
Tag count. |
Summary: Target Resource
Description: Target resource.
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
The ID of the resource. |
|
resourceName |
string Name |
The name of the resource. |
|
resourceType |
string Type |
The type of the resource. |
Summary:
Description: Entity representing the reference to the template.
Properties:
|
Name |
Type |
Summary |
|
uri |
string Template URI |
URI referencing the template. |
|
contentVersion |
string Template Content Version |
If included it must match the ContentVersion in the template. |