Connectors Reference

Azure Resource Manager

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

 

Status: Preview

Tier: Standard

Version: 2016-06-01

 

Actions:

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

Subscriptions_List ([internal]string x-ms-api-version)

List subscriptions

AsyncOperations_Get (string subscriptionId, string operationResult, [internal]string x-ms-api-version)

Reads an async operation (internal)

Deployments_Get (string subscriptionId, string resourceGroupName, string deploymentName, [internal]string x-ms-api-version, [Optional]boolean wait)

Read a template deployment

Deployments_CreateOrUpdate (string subscriptionId, string resourceGroupName, string deploymentName, Deployment parameters, [internal]string x-ms-api-version, [Optional]boolean wait)

Create or update a template deployment

Deployments_Delete (string subscriptionId, string resourceGroupName, string deploymentName, [internal]string x-ms-api-version)

Delete template deployment

Deployments_Cancel (string subscriptionId, string resourceGroupName, string deploymentName, [internal]string x-ms-api-version)

Cancel a template deployment

Deployments_Validate (string subscriptionId, string resourceGroupName, string deploymentName, Deployment parameters, [internal]string x-ms-api-version)

Validate a template deployment

Deployments_ExportTemplate (string subscriptionId, string resourceGroupName, string deploymentName, [internal]string x-ms-api-version)

Export deployment template

Deployments_List (string subscriptionId, string resourceGroupName, [advanced][Optional]string $filter, [advanced][Optional]integer $top, [internal]string x-ms-api-version)

List template deployments

DeploymentOperations_Get (string subscriptionId, string resourceGroupName, string deploymentName, string operationId, [internal]string x-ms-api-version)

Read a template deployment operation

DeploymentOperations_List (string subscriptionId, string resourceGroupName, string deploymentName, [advanced][Optional]integer $top, [internal]string x-ms-api-version)

Lists template deployment operations

Providers_Unregister (string subscriptionId, string resourceProviderNamespace, [internal]string x-ms-api-version)

Unregister resource provider

Providers_Register (string subscriptionId, string resourceProviderNamespace, [internal]string x-ms-api-version)

Register resource provider

Providers_List (string subscriptionId, [advanced][Optional]integer $top, [advanced][Optional]string $expand, [internal]string x-ms-api-version)

List resource providers

Providers_Get (string subscriptionId, string resourceProviderNamespace, [advanced][Optional]string $expand, [internal]string x-ms-api-version)

Read resource provider

ResourceGroups_ListResources ([internal]string x-ms-api-version, string subscriptionId, string resourceGroupName, [advanced][Optional]string $filter, [advanced][Optional]string $expand, [advanced][Optional]integer $top)

List resources by resource group

ResourceGroups_Get (string subscriptionId, string resourceGroupName, [internal]string x-ms-api-version)

Read a resource group

ResourceGroups_CreateOrUpdate (string subscriptionId, string resourceGroupName, ResourceGroup parameters, [internal]string x-ms-api-version)

Create or update a resource group

ResourceGroups_Delete (string subscriptionId, string resourceGroupName, [internal]string x-ms-api-version)

Delete a resource group

ResourceGroups_Patch (string subscriptionId, string resourceGroupName, ResourceGroup parameters, [internal]string x-ms-api-version)

Update an existing resource group

ResourceGroups_ExportTemplate (string subscriptionId, string resourceGroupName, ExportTemplateRequest parameters, [internal]string x-ms-api-version)

Export a resource group template

ResourceGroups_List ([internal]string x-ms-api-version, string subscriptionId, [advanced][Optional]string $filter, [advanced][Optional]integer $top)

List resource groups

Resources_List (string subscriptionId, [advanced][Optional]string $filter, [advanced][Optional]string $expand, [advanced][Optional]integer $top, [internal]string x-ms-api-version)

List resources by subscription

Resources_GetById (string subscriptionId, string resourceGroupName, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version)

Read a resource

Resources_CreateOrUpdateById (string subscriptionId, string resourceGroupName, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version, GenericResource parameters)

Create or update a resource

Resources_DeleteById (string subscriptionId, string resourceGroupName, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version)

Delete a resource

Resources_Invoke (string subscriptionId, string resourceGroupName, string resourceProviderNamespace, string shortResourceId, string x-ms-api-version, string actionName, [Optional]Resources_InvokeParameterBody body)

Invoke resource operation

Tags_CreateOrUpdateValue (string subscriptionId, string tagName, string tagValue, [internal]string x-ms-api-version)

Create or update a subscription resource tag value

Tags_DeleteValue (string subscriptionId, string tagName, string tagValue, [internal]string x-ms-api-version)

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

GetAsyncStatus (string url)

Get operation status

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AliasPathType

 

AliasType

 

AsyncOperations_GetResponse

 

BasicDependency

 

DebugSetting

 

Dependency

 

Deployment

 

DeploymentExportResult

 

DeploymentExtended

 

DeploymentListResult

 

DeploymentOperation

 

DeploymentOperationProperties

 

DeploymentOperationsListResult

 

DeploymentProperties

 

DeploymentPropertiesExtended

 

DeploymentValidateResult

 

ExportTemplateRequest

 

GenericResource

 

GetAsyncStatusResponse

Action response

HttpMessage

 

Identity

Identity

Location

 

LocationListResult

 

ParametersLink

 

Plan

 

Provider

 

ProviderListResult

 

ProviderResourceType

 

ResourceGroup

 

ResourceGroupExportResult

 

ResourceGroupListResult

 

ResourceGroupProperties

 

ResourceListResult

 

ResourceManagementErrorWithDetails

 

Resources_InvokeParameterBody

 

Resources_InvokeResponse

Action response

Sku

SKU

Subscription

 

SubscriptionListResult

 

SubscriptionPolicies

Subscription Policies

TagCount

Tag Count

TagDetails

 

TagsListResult

 

TagValue

 

TargetResource

Target Resource

TemplateLink

 

 

Actions:

Subscriptions_ListLocations

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

Subscriptions_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:LocationListResult

          Description: Location list operation response.

 

Subscriptions_Get

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

Subscriptions_List

 

Returns:

          Type:Subscription

          Description: Subscription information.

 

Subscriptions_List

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:

          Type:SubscriptionListResult

          Description: Subscription list operation response.

 

AsyncOperations_Get

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

Subscriptions_List

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.

 

Deployments_Get

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

deploymentName

string

(Deployment Name)

The name of the resource group template deployment.

True

Deployments_List

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.

 

Deployments_CreateOrUpdate

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

deploymentName

string

(Deployment Name)

The name of the deployment.

True

parameters

Deployment

 

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.

 

Deployments_Delete

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

deploymentName

string

(Deployment Name)

The name of the resource group template deployment.

True

Deployments_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

 

Deployments_Cancel

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

deploymentName

string

(Deployment Name)

The name of the resource group template deployment.

True

Deployments_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

 

Deployments_Validate

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

deploymentName

string

(Deployment Name)

The name of the resource group template deployment.

True

Deployments_List

parameters

Deployment

 

Deployment operation parameters.

True

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:DeploymentValidateResult

          Description: Information from validate template deployment response.

 

Deployments_ExportTemplate

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

deploymentName

string

(Deployment Name)

The name of the resource group template deployment.

True

Deployments_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:DeploymentExportResult

          Description: The deployment export result.

 

Deployments_List

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

$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.

 

DeploymentOperations_Get

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

deploymentName

string

(Deployment Name)

The name of the resource group template deployment.

True

Deployments_List

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.

 

DeploymentOperations_List

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

deploymentName

string

(Deployment Name)

The name of the resource group template deployment.

True

Deployments_List

$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.

 

Providers_Unregister

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

Subscriptions_List

resourceProviderNamespace

string

(Resource Provider)

Namespace of the resource provider.

True

Providers_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:Provider

          Description: Resource provider information.

 

Providers_Register

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

Subscriptions_List

resourceProviderNamespace

string

(Resource Provider)

Namespace of the resource provider.

True

Providers_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:Provider

          Description: Resource provider information.

 

Providers_List

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

Subscriptions_List

$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.

 

Providers_Get

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

Subscriptions_List

resourceProviderNamespace

string

(Resource Provider)

Namespace of the resource provider.

True

Providers_List

$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.

 

ResourceGroups_ListResources

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

$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.

 

ResourceGroups_Get

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:ResourceGroup

          Description: Resource group information.

 

ResourceGroups_CreateOrUpdate

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

Subscriptions_List

resourceGroupName

string

(Resource Group Name)

The name of the resource group to be created or updated.

True

parameters

ResourceGroup

 

Resource group information.

True

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:ResourceGroup

          Description: Resource group information.

 

ResourceGroups_Delete

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

 

ResourceGroups_Patch

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

parameters

ResourceGroup

 

Resource group information.

True

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:ResourceGroup

          Description: Resource group information.

 

ResourceGroups_ExportTemplate

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

parameters

ExportTemplateRequest

 

Export resource group template request parameters.

True

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:ResourceGroupExportResult

 

ResourceGroups_List

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

Subscriptions_List

$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:

          Type:ResourceGroupListResult

          Description: List of resource groups.

 

Resources_List

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

Subscriptions_List

$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.

 

Resources_GetById

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

resourceProviderNamespace

string

(Resource Provider)

Namespace of the resource provider.

True

Providers_List

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.

 

Resources_CreateOrUpdateById

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

resourceProviderNamespace

string

(Resource Provider)

Namespace of the resource provider.

True

Providers_List

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

GenericResource

 

Resource information.

True

 

Returns:

          Type:GenericResource

          Description: Resource information.

 

Resources_DeleteById

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

resourceProviderNamespace

string

(Resource Provider)

Namespace of the resource provider.

True

Providers_List

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:

 

Resources_Invoke

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

Subscriptions_List

resourceGroupName

string

(Resource Group)

Resource group name.

True

ResourceGroups_List

resourceProviderNamespace

string

(Resource Provider)

Namespace of the resource provider.

True

Providers_List

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

Resources_InvokeParameterBody

 

 

False

 

Returns:

          Type:Resources_InvokeResponse

          Summary: Action response

          Description: The response from the action operation.

 

Tags_CreateOrUpdateValue

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

Subscriptions_List

tagName

string

(Tag Name)

The name of the tag.

True

Tags_List

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.

 

Tags_DeleteValue

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

Subscriptions_List

tagName

string

(Tag Name)

The name of the tag.

True

Tags_List

tagValue

string

(Tag Value)

The value of the tag.

True

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

 

Tags_CreateOrUpdate

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

Subscriptions_List

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.

 

Tags_Delete

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

Subscriptions_List

tagName

string

(Tag Name)

The name of the tag.

True

Tags_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

 

Tags_List

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

Subscriptions_List

x-ms-api-version

string

Values: [2016-06-01]

Client Api Version.

True

 

Returns:

          Type:TagsListResult

          Description: List of subscription tags.

 

GetAsyncStatus

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:

          Type:GetAsyncStatusResponse

          Summary: Action response

          Description: The response from the redirect operation.

 


 

AliasPathType

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.


 

AliasType

Summary:

Description: The alias type.

 

          Properties:

Name

Type

Summary

name

string

 

The alias name.

paths

array of (AliasPathType)

 

The paths for an alias.


 

AsyncOperations_GetResponse

Summary:

Description: Async operations response.

 

          Properties:

Name

Type

Summary


 

BasicDependency

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.


 

DebugSetting

Summary:

Description:

 

          Properties:

Name

Type

Summary

detailLevel

string

Detail Level

The debug detail level.


 

Dependency

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.


 

Deployment

Summary:

Description: Deployment operation parameters.

 

          Properties:

Name

Type

Summary

properties

DeploymentProperties

 

Deployment properties.


 

DeploymentExportResult

Summary:

Description: The deployment export result.

 

          Properties:

Name

Type

Summary

template

Template

Template

The template content.

 

Template

Summary: Template

Description: The template content.

 

          Properties:

Name

Type

Summary

 


 

DeploymentExtended

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

DeploymentPropertiesExtended

 

Deployment properties with additional details.


 

DeploymentListResult

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.


 

DeploymentOperation

Summary:

Description: Deployment operation information.

 

          Properties:

Name

Type

Summary

id

string

Id

Full deployment operation id.

operationId

string

Operation Id

Deployment operation id.

properties

DeploymentOperationProperties

 

Deployment operation properties.


 

DeploymentOperationProperties

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

StatusMessage

 

Operation status message.

targetResource

TargetResource

Target Resource

Target resource.

request

HttpMessage

 

 

response

HttpMessage

 

 

 

StatusMessage

Summary:

Description: Operation status message.

 

          Properties:

Name

Type

Summary

 


 

DeploymentOperationsListResult

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.


 

DeploymentProperties

Summary:

Description: Deployment properties.

 

          Properties:

Name

Type

Summary

template

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

TemplateLink

 

Entity representing the reference to the template.

parameters

Parameters

Parameters

Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink.

parametersLink

ParametersLink

 

Entity representing the reference to the deployment paramaters.

mode

string

Deployment Mode

The deployment mode.  Values: [Incremental, Complete]

debugSetting

DebugSetting

 

 

 

Template

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

 

Parameters

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

 


 

DeploymentPropertiesExtended

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

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

Template

 

The template content. Use only one of Template or TemplateLink.

templateLink

TemplateLink

 

Entity representing the reference to the template.

parameters

Parameters

 

Deployment parameters. Use only one of Parameters or ParametersLink.

parametersLink

ParametersLink

 

Entity representing the reference to the deployment paramaters.

mode

string

Deployment Mode

The deployment mode.  Values: [Incremental, Complete]

debugSetting

DebugSetting

 

 

 

Outputs

Summary:

Description: Key/value pairs that represent deploymentoutput.

 

          Properties:

Name

Type

Summary

 

Template

Summary:

Description: The template content. Use only one of Template or TemplateLink.

 

          Properties:

Name

Type

Summary

 

Parameters

Summary:

Description: Deployment parameters. Use only one of Parameters or ParametersLink.

 

          Properties:

Name

Type

Summary

 


 

DeploymentValidateResult

Summary:

Description: Information from validate template deployment response.

 

          Properties:

Name

Type

Summary

error

ResourceManagementErrorWithDetails

 

 

properties

DeploymentPropertiesExtended

 

Deployment properties with additional details.


 

ExportTemplateRequest

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.  Values: [*]

options

string

 

The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments  Values: [IncludeParameterDefaultValue, IncludeComments, IncludeParameterDefaultValue, IncludeComments]


 

GenericResource

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

Tags

Resource tags

plan

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

Sku for the resource.

identity

Identity

Identity

Identity for the resource.

properties

Properties

Properties

The resource properties.

 

Tags

Summary: Tags

Description: Resource tags

 

          Properties:

Name

Type

Summary

 

Properties

Summary: Properties

Description: The resource properties.

 

          Properties:

Name

Type

Summary

 


 

GetAsyncStatusResponse

Summary: Action response

Description: The response from the redirect operation.

 

          Properties:

Name

Type

Summary


 

HttpMessage

Summary:

Description:

 

          Properties:

Name

Type

Summary

content

Content

 

HTTP message content.

 

Content

Summary:

Description: HTTP message content.

 

          Properties:

Name

Type

Summary

 


 

Identity

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]


 

Location

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.


 

LocationListResult

Summary:

Description: Location list operation response.

 

          Properties:

Name

Type

Summary

value

array of (Location)

 

The locations.


 

ParametersLink

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.


 

Plan

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.


 

Provider

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.


 

ProviderListResult

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.


 

ProviderResourceType

Summary:

Description: Resource type managed by the resource provider.

 

          Properties:

Name

Type

Summary

resourceType

string

 

The resource type.

locations

array of (string)

 

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

Properties

 

The properties.

 

Properties

Summary:

Description: The properties.

 

          Properties:

Name

Type

Summary

 


 

ResourceGroup

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

Tags

The tags attached to the resource group.

properties

ResourceGroupProperties

 

The resource group properties.

 

Tags

Summary: Tags

Description: The tags attached to the resource group.

 

          Properties:

Name

Type

Summary

 


 

ResourceGroupExportResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

template

Template

Template

The template content.

error

ResourceManagementErrorWithDetails

 

 

 

Template

Summary: Template

Description: The template content.

 

          Properties:

Name

Type

Summary

 


 

ResourceGroupListResult

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.


 

ResourceGroupProperties

Summary:

Description: The resource group properties.

 

          Properties:

Name

Type

Summary

provisioningState

string

Provisioning State

The provisioning state.


 

ResourceListResult

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.


 

ResourceManagementErrorWithDetails

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.

 

DetailsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

Resources_InvokeParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Resources_InvokeResponse

Summary: Action response

Description: The response from the action operation.

 

          Properties:

Name

Type

Summary


 

Sku

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.


 

Subscription

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

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'.


 

SubscriptionListResult

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.


 

SubscriptionPolicies

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]


 

TagCount

Summary: Tag Count

Description: Tag count.

 

          Properties:

Name

Type

Summary

type

string

Type

Type of count.

value

string

Value

Value of count.


 

TagDetails

Summary:

Description: Tag details.

 

          Properties:

Name

Type

Summary

id

string

Id

The tag ID.

tagName

string

Name

The tag name.

count

TagCount

Tag Count

Tag count.

values

array of (TagValue)

 

The list of tag values.


 

TagsListResult

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.


 

TagValue

Summary:

Description: Tag information.

 

          Properties:

Name

Type

Summary

id

string

Tag Id

The tag ID.

tagValue

string

Tag Value

The tag value.

count

TagCount

Tag Count

Tag count.


 

TargetResource

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.


 

TemplateLink

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.