Azure Resource Manager (Preview)

Azure Resource Manager (Preview)

Azure Resource Manager exposes the APIs to manage all of your Azure resources.

Note:

  • This is a Standard connector.

Throttling Limits

Name Calls Renewal Period
API calls per connection 1200 60 seconds
Frequency of trigger polls 1 15 seconds

Creating a connection

To connect your account, you will need the following information:

Client ID
string
Client (or Application) ID of the Azure Active Directory application.
Client Secret
securestring
Client secret of the Azure Active Directory application.
Tenant
string
The tenant ID of for the Azure Active Directory application.
ResourceUri
string
The resource you are requesting authorization to use.
Grant Type
string
Grant type

Actions

Cancel a template deployment

Cancel a currently running template deployment. All pending template operations will be suspended.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the resource group template deployment.

Create or update a resource

Creates or updates a resource. The response code can be used to distinguish between a create (201) or update (200).

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Resource Provider
string
Namespace of the resource provider.
Short Resource Id
string
The short Id of the resource, including the resource name and resource type. For example, sites/mySite
Client Api Version
string
Api Version to be used.

Optional Parameters

Id
string
Resource Id
Name
string
Resource name
Type
string
Resource type
Location
string
Resource location
Id
string
The plan ID.
Publisher
string
The publisher ID.
Product
string
The offer ID.
Promotion Code
string
The promotion code.
Kind
string
The kind of the resource.
Managed By
string
Id of the resource that manages this resource.
Name
string
The sku name.
Tier
string
The sku tier.
Size
string
The sku size.
Family
string
The sku family.
Model
string
The sku model.
Capacity
integer
The sku capacity.
Principal Id
string
The principal id of resource identity.
Tenant Id
string
The tenant id of resource.
Type
string
The identity type.

Returns

Body
GenericResource

Resource information.

Create or update a resource group

Creates or updates a resource group. The response code can be used to distinguish between a create (201) or update (200).

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group Name
string
The name of the resource group to be created or updated.
Location
string
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.

Optional Parameters

Id
string
The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).
Name
string
The Name of the resource group.
Managed By
string
Id of the resource that manages this resource group.
Provisioning State
string
The provisioning state.

Returns

Body
ResourceGroup

Resource group information.

Create or update a subscription resource tag name

Create or update a subscription resource tag name.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Tag Name
string
The name of the tag.

Returns

Body
TagDetails

Tag details.

Create or update a subscription resource tag value

Create or update a subscription resource tag value.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Tag Name
string
The name of the tag.
Tag Value
string
The value of the tag.

Returns

Body
TagValue

Tag information.

Create or update a template deployment

Create or update a named resource group template deployment. A template and parameters are expected for the request to succeed.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the deployment.
Template URI
string
URI referencing the template.
Parameters URI
string
URI referencing the template.
Deployment Mode
string
The deployment mode.

Optional Parameters

Template Content Version
string
If included it must match the ContentVersion in the template.
Parameters Content Version
string
If included it must match the ContentVersion in the template.
Detail Level
string
The debug detail level.
Wait for Deployment
boolean
If the action should wait until deployment is completed

Returns

Body
DeploymentExtended

Deployment information.

Delete a resource

Deletes a resource.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Resource Provider
string
Namespace of the resource provider.
Short Resource Id
string
The short Id of the resource, including the resource name and resource type. For example, sites/mySite
Client Api Version
string
Api Version to be used.

Delete a resource group

Delete a particular resource group within the subscription.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.

Delete a subscription resource tag name

Delete a subscription resource tag name.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Tag Name
string
The name of the tag.

Delete a subscription resource tag value

Delete a subscription resource tag value.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Tag Name
string
The name of the tag.
Tag Value
string
The value of the tag.

Delete template deployment

Deletes a resource group template deployment. The resources will not be deleted; only the metadata about the template deployment.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the resource group template deployment.

Export a resource group template

Exports a deployment template from an existing resource group. This can only be successful if the underlying resources have a schema defined by Microsoft.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.

Optional Parameters

resources
string
options
string
The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments

Returns

Export deployment template

Exports a template from a past resource group deployment.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the resource group template deployment.

Returns

Body
DeploymentExportResult

The deployment export result.

Invoke resource operation

Invokes an operation on an Azure resource.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Resource Provider
string
Namespace of the resource provider.
Short Resource Id
string
The short Id of the resource, including the resource name and resource type. For example, sites/mySite
Client Api Version
string
Api Version to be used.
Action name
string
Name of the resource action to invoke

List resource groups

Lists all the resource groups within the subscription. The results are paginated at 1,000+ records.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Optional Parameters

Filter
string
The filter to apply on the operation.
Top
integer
Query parameters. If nothing is passed returns all values.

Returns

Body
ResourceGroupListResult

List of resource groups.

List resource providers

Lists the resource providers available for the subscription.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Optional Parameters

Top
integer
Query parameters. If nothing is passed returns all values.
Expand
string
The $expand query parameter.

Returns

Body
ProviderListResult

List of resource providers.

List resources by resource group

Lists all the resources under a resource group.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.

Optional Parameters

Filter
string
The filter to apply on the operation.
Expand
string
The $expand query parameter.
Top
integer
Query parameters. If nothing is passed returns all values.

Returns

Body
ResourceListResult

List of resources.

List resources by subscription

Reads all of the resources under a particular subscription. The results are paginated at 1,000+ records.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Optional Parameters

Filter
string
The filter to apply on the operation.
Expand
string
The $expand query parameter.
Top
integer
Query parameters. If nothing is passed returns all values.

Returns

Body
ResourceListResult

List of resources.

List subscription resource tags

Lists all the subscription resource tags.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Returns

Body
TagsListResult

List of subscription tags.

List subscriptions

Gets a list of all the subscriptions to which the principal has access.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the resource group template deployment.

Returns

Body
SubscriptionListResult

Subscription list operation response.

List template deployments

Lists all the resource group template deployments. This operation is useful to know what has been provisioned thus far.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.

Optional Parameters

Filter
string
The filter to apply on the operation.
Top
integer
Query parameters. If nothing is passed returns all values.

Returns

Body
DeploymentListResult

List of deployments.

Lists template deployment operations

Lists all the template deployment operations. This is useful for troubleshooting failed template deployments.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the resource group template deployment.

Optional Parameters

Top
integer
Query parameters. If nothing is passed returns all values.

Returns

Body
DeploymentOperationsListResult

List of deployment operations.

Lists the subscription locations

Lists the locations available for the subscription.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Returns

Body
LocationListResult

Location list operation response.

Read a resource

Reads a resource object.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Resource Provider
string
Namespace of the resource provider.
Short Resource Id
string
The short Id of the resource, including the resource name and resource type. For example, sites/mySite
Client Api Version
string
Api Version to be used.

Returns

Body
GenericResource

Resource information.

Read a resource group

Reads a particular resource group within the subscription.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.

Returns

Body
ResourceGroup

Resource group information.

Read a subscription

Reads the details for a particular subscription.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Returns

Body
Subscription

Subscription information.

Read a template deployment

Reads a template deployment within a resource group.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the resource group template deployment.

Optional Parameters

Wait for Deployment
boolean
If the action should wait until deployment is completed

Returns

Body
DeploymentExtended

Deployment information.

Read a template deployment operation

Reads a particular resource group template deployment operation. This is useful for troubleshooting failed template deployments.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the resource group template deployment.
Operation Id
string
Operation Id.

Returns

Body
DeploymentOperation

Deployment operation information.

Read resource provider

Reads a particular resource provider within the subscription.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Provider
string
Namespace of the resource provider.

Optional Parameters

Expand
string
The $expand query parameter.

Returns

Body
Provider

Resource provider information.

Register resource provider

Registers a resource provider to be used with a subscription. This will provision permissions for the service into your subscription.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Provider
string
Namespace of the resource provider.

Returns

Body
Provider

Resource provider information.

Unregister resource provider

Unregisters provider from a subscription. This operation will fail if there are any resources from that resource provider in the subscription.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Provider
string
Namespace of the resource provider.

Returns

Body
Provider

Resource provider information.

Update an existing resource group

Updates an existing resource group. If the resource does not exist, this request will fail.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Location
string
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.

Optional Parameters

Id
string
The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).
Name
string
The Name of the resource group.
Managed By
string
Id of the resource that manages this resource group.
Provisioning State
string
The provisioning state.

Returns

Body
ResourceGroup

Resource group information.

Validate a template deployment

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.

Required Parameters

Subscription
string
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.
Resource Group
string
Resource group name.
Deployment Name
string
The name of the resource group template deployment.
Template URI
string
URI referencing the template.
Parameters URI
string
URI referencing the template.
Deployment Mode
string
The deployment mode.

Optional Parameters

Template Content Version
string
If included it must match the ContentVersion in the template.
Parameters Content Version
string
If included it must match the ContentVersion in the template.
Detail Level
string
The debug detail level.

Returns

Body
DeploymentValidateResult

Information from validate template deployment response.

Definitions

Location

Location information.

Display Name
string
The display name of the location.
Id
string
The fully qualified Id of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus.
Latitude
string
The latitude of the location.
Location Name
string
The location name.
Longitude
string
The longitude of the location.
Subscription Id
string
The subscription Id.

LocationListResult

Location list operation response.

value
array of Location
The locations.

Subscription

Subscription information.

Authorization Source
string
The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.
Display Name
string
The subscription display name.
Id
string
The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.
State
string
The subscription state.
Subscription Id
string
The subscription Id.
Subscription Policies
SubscriptionPolicies
Subscription policies.
Tenant Id
string
The tenant Id.

SubscriptionPolicies

Subscription policies.

Location Placement Id
string
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.
Quota Id
string
The subscription quota Id.
Spending Limit
string
The subscription spending limit.

SubscriptionListResult

Subscription list operation response.

Next Link
string
The URL to get the next set of results.
value
array of Subscription
The subscriptions.

Entity representing the reference to the template.

Template Content Version
string
If included it must match the ContentVersion in the template.
Template URI
string
URI referencing the template.

Entity representing the reference to the deployment paramaters.

Parameters Content Version
string
If included it must match the ContentVersion in the template.
Parameters URI
string
URI referencing the template.

DebugSetting

Detail Level
string
The debug detail level.

DeploymentExportResult

The deployment export result.

Template
object
The template content.

ResourceManagementErrorWithDetails

code
string
The error code returned from the server.
details
array of object
Validation error.
message
string
The error message returned from the server.
target
string
The target of the error.

AliasPathType

The type of the paths for alias.

apiVersions
array of string
The api versions.
path
string
The path of an alias.

AliasType

The alias type.

name
string
The alias name.
paths
array of AliasPathType
The paths for an alias.

ProviderResourceType

Resource type managed by the resource provider.

aliases
array of AliasType
The aliases that are supported by this resource type.
apiVersions
array of string
The api version.
locations
array of string
The collection of locations where this resource type can be created in.
properties
object
The properties.
resourceType
string
The resource type.

Provider

Resource provider information.

Id
string
The provider id.
Namespace
string
The namespace of the provider.
Registration State
string
The registration state of the provider.
Resource Type
array of ProviderResourceType
The collection of provider resource types.

BasicDependency

Deployment dependency information.

id
string
The ID of the dependency.
resourceName
string
The dependency resource name.
resourceType
string
The dependency resource type.

Dependency

Deployment dependency information.

dependsOn
array of BasicDependency
The list of dependencies.
id
string
The ID of the dependency.
resourceName
string
The dependency resource name.
resourceType
string
The dependency resource type.

DeploymentPropertiesExtended

Deployment properties with additional details.

Deployment Mode
string
The deployment mode.
correlationId
string
The correlation ID of the deployment.
debugSetting
DebugSetting
Deployment properties with additional details.
dependencies
array of Dependency
The list of deployment dependencies.
outputs
object
Key/value pairs that represent deploymentoutput.
parameters
object
Deployment parameters. Use only one of Parameters or ParametersLink.
parametersLink
ParametersLink
Entity representing the reference to the deployment paramaters.
providers
array of Provider
The list of resource providers needed for the deployment.
provisioningState
string
The state of the provisioning.
template
object
The template content. Use only one of Template or TemplateLink.
templateLink
TemplateLink
Entity representing the reference to the template.
timestamp
date-time
The timestamp of the template deployment.

DeploymentValidateResult

Information from validate template deployment response.

error
ResourceManagementErrorWithDetails
Information from validate template deployment response.
properties
DeploymentPropertiesExtended
Deployment properties with additional details.

DeploymentExtended

Deployment information.

Id
string
The ID of the deployment.
Name
string
The name of the deployment.
properties
DeploymentPropertiesExtended
Deployment properties with additional details.

DeploymentListResult

List of deployments.

Next Link
string
The URL to get the next set of results.
value
array of DeploymentExtended
The list of deployments.

ProviderListResult

List of resource providers.

nextLink
string
The URL to get the next set of results.
value
array of Provider
The list of resource providers.

GenericResource

Resource information.

Id
string
Resource Id
Identity
Identity
Identity for the resource.
Kind
string
The kind of the resource.
Location
string
Resource location
Managed By
string
Id of the resource that manages this resource.
Name
string
Resource name
Properties
object
The resource properties.
SKU
Sku
Sku for the resource.
Tags
object
Resource tags
Type
string
Resource type
plan
Plan
Plan for the resource.

Plan

Plan for the resource.

Id
string
The plan ID.
Product
string
The offer ID.
Promotion Code
string
The promotion code.
Publisher
string
The publisher ID.

Sku

Sku for the resource.

Capacity
integer
The sku capacity.
Family
string
The sku family.
Model
string
The sku model.
Name
string
The sku name.
Size
string
The sku size.
Tier
string
The sku tier.

Identity

Identity for the resource.

Principal Id
string
The principal id of resource identity.
Tenant Id
string
The tenant id of resource.
Type
string
The identity type.

ResourceListResult

List of resources.

Next Link
string
The URL to get the next set of results.
value
array of GenericResource
The list of resources.

ResourceGroup

Resource group information.

Id
string
The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).
Location
string
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.
Managed By
string
Id of the resource that manages this resource group.
Name
string
The Name of the resource group.
Tags
object
The tags attached to the resource group.
properties
ResourceGroupProperties
The resource group properties.

ResourceGroupProperties

The resource group properties.

Provisioning State
string
The provisioning state.

ResourceGroupListResult

List of resource groups.

Next Link
string
The URL to get the next set of results.
value
array of ResourceGroup
The list of resource groups.

TagCount

Tag count.

Type
string
Type of count.
Value
string
Value of count.

TagValue

Tag information.

Tag Count
TagCount
Tag count.
Tag Id
string
The tag ID.
Tag Value
string
The tag value.

TagDetails

Tag details.

Id
string
The tag ID.
Name
string
The tag name.
Tag Count
TagCount
Tag count.
values
array of TagValue
The list of tag values.

TagsListResult

List of subscription tags.

nextLink
string
The URL to get the next set of results.
value
array of TagDetails
The list of tags.

TargetResource

Target resource.

Id
string
The ID of the resource.
Name
string
The name of the resource.
Type
string
The type of the resource.

HttpMessage

content
object
HTTP message content.

DeploymentOperationProperties

Deployment operation properties.

Target Resource
TargetResource
Target resource.
provisioningState
string
The state of the provisioning.
request
HttpMessage
Deployment operation properties.
response
HttpMessage
Deployment operation properties.
serviceRequestId
string
Deployment operation service request id.
statusCode
string
Operation status code.
statusMessage
object
Operation status message.
timestamp
date-time
The date and time of the operation.

DeploymentOperation

Deployment operation information.

Id
string
Full deployment operation id.
Operation Id
string
Deployment operation id.
properties
DeploymentOperationProperties
Deployment operation properties.

DeploymentOperationsListResult

List of deployment operations.

Next Link
string
The URL to get the next set of results.
value
array of DeploymentOperation
The list of deployments.

ResourceGroupExportResult

Template
object
The template content.
error
ResourceManagementErrorWithDetails