Microsoft.Resources (stable:2019-03-01)

2025/12/05 • 31 new, 31 deleted methods

Operations_List (new)
Description :  Lists all of the available Microsoft.Resources REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Resources operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Resources ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Providers_Unregister (new)
Description :  Unregisters a subscription from a resource provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister
{
resourceProviderNamespace:
{
Description: The namespace of the resource provider to unregister. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_Register (new)
Description :  Registers a subscription with a resource provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register
{
resourceProviderNamespace:
{
Description: The namespace of the resource provider to register. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_List (new)
Description :  Gets all resource providers for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers
{
$top:
{
Description: The number of results to return. If null is passed returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
$expand:
{
Description: The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resource providers. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Providers_Get (new)
Description :  Gets the specified resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
{
$expand:
{
Description: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Resources_ListByResourceGroup (new)
Description :  Get all the resources for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources
{
resourceGroupName:
{
Description: The resource group with the resources to get. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation.

The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

You can link more than one substringof together by adding and/or operators.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'

You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return. If null is passed, returns all resources. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resources. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
ResourceGroups_CheckExistence (new)
Description :  Checks whether a resource group exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to check. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
ResourceGroups_CreateOrUpdate (new)
Description :  Creates or updates a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a resource group. ,
Required: True ,
}
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Delete (new)
Description :  When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to delete. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
ResourceGroups_Get (new)
Description :  Gets a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Update (new)
Description :  Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to update. The name is case insensitive. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update a resource group. ,
Required: True ,
}
{
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_ExportTemplate (new)
Description :  Captures the specified resource group as a template.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate
{
resourceGroupName:
{
Description: The name of the resource group to export as a template. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for exporting the template. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'. ,
Required: False ,
}
[
string ,
]
,
options:
{
Description: The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization' ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: The error code returned when exporting the template. ,
Required: False ,
}
string ,
message:
{
Description: The error message describing the export error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Validation error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ResourceGroups_List (new)
Description :  Gets all the resource groups for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups
{
$filter:
{
Description: The filter to apply on the operation.

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

⚐ Response (200)

{
value:
{
Description: An array of resource groups. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Resources_MoveResources (new)
Description :  The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources
{
sourceResourceGroupName:
{
Description: The name of the resource group containing the resources to move. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for moving resources. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources
{
sourceResourceGroupName:
{
Description: The name of the resource group containing the resources to validate for move. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for moving resources. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (409)

{}
Resources_List (new)
Description :  Get all the resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resources
{
$filter:
{
Description: The filter to apply on the operation.

The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

You can link more than one substringof together by adding and/or operators.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'

You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return. If null is passed, returns all resources. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resources. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Resources_CheckExistence (new)
Description :  Checks whether a resource exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource to check. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The resource provider of the resource to check. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to check whether it exists. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Resources_Delete (new)
Description :  Deletes a resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource to delete. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Resources_CreateOrUpdate (new)
Description :  Creates a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group for the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to create. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating or updating the resource. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}
Resources_Update (new)
Description :  Updates a resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group for the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to update. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating the resource. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}
Resources_Get (new)
Description :  Gets a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource to get. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
Resources_CheckExistenceById (new)
Description :  Checks by ID whether a resource exists.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (404)

{}
Resources_DeleteById (new)
Description :  Deletes a resource by ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Resources_CreateOrUpdateById (new)
Description :  Create a resource by ID.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update resource parameters. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}
Resources_UpdateById (new)
Description :  Updates a resource by ID.
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Update resource parameters. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}
Resources_GetById (new)
Description :  Gets a resource by ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
Tags_DeleteValue (new)
Description :  Deletes a tag value.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_CreateOrUpdateValue (new)
Description :  Creates a tag value. The name of the tag must already exist.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
Tags_CreateOrUpdate (new)
Description :  The tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You cannot create tags with one of these prefixes.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
Tags_Delete (new)
Description :  You must remove all values from a resource tag before you can delete it.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_List (new)
Description :  Gets the names and values of all resource tags that are defined in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/tagNames
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of tags. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Lists all of the available Microsoft.Resources REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Resources operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Resources ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Providers_Unregister (removed)
Description :  Unregisters a subscription from a resource provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister
{
resourceProviderNamespace:
{
Description: The namespace of the resource provider to unregister. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_Register (removed)
Description :  Registers a subscription with a resource provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register
{
resourceProviderNamespace:
{
Description: The namespace of the resource provider to register. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_List (removed)
Description :  Gets all resource providers for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers
{
$top:
{
Description: The number of results to return. If null is passed returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
$expand:
{
Description: The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resource providers. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Providers_Get (removed)
Description :  Gets the specified resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
{
$expand:
{
Description: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Resources_ListByResourceGroup (removed)
Description :  Get all the resources for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources
{
resourceGroupName:
{
Description: The resource group with the resources to get. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation.

The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

You can link more than one substringof together by adding and/or operators.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'

You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return. If null is passed, returns all resources. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resources. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
ResourceGroups_CheckExistence (removed)
Description :  Checks whether a resource group exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to check. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
ResourceGroups_CreateOrUpdate (removed)
Description :  Creates or updates a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a resource group. ,
Required: True ,
}
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Delete (removed)
Description :  When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to delete. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
ResourceGroups_Get (removed)
Description :  Gets a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Update (removed)
Description :  Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to update. The name is case insensitive. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update a resource group. ,
Required: True ,
}
{
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_ExportTemplate (removed)
Description :  Captures the specified resource group as a template.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate
{
resourceGroupName:
{
Description: The name of the resource group to export as a template. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for exporting the template. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'. ,
Required: False ,
}
[
string ,
]
,
options:
{
Description: The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization' ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
error:
{
Description: The error. ,
Required: False ,
}
{
code:
{
Description: The error code returned when exporting the template. ,
Required: False ,
}
string ,
message:
{
Description: The error message describing the export error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Validation error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ResourceGroups_List (removed)
Description :  Gets all the resource groups for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups
{
$filter:
{
Description: The filter to apply on the operation.

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

⚐ Response (200)

{
value:
{
Description: An array of resource groups. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Resources_MoveResources (removed)
Description :  The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources
{
sourceResourceGroupName:
{
Description: The name of the resource group containing the resources to move. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for moving resources. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources
{
sourceResourceGroupName:
{
Description: The name of the resource group containing the resources to validate for move. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for moving resources. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (409)

{}
Resources_List (removed)
Description :  Get all the resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resources
{
$filter:
{
Description: The filter to apply on the operation.

The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

You can link more than one substringof together by adding and/or operators.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'

You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return. If null is passed, returns all resources. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resources. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
Resources_CheckExistence (removed)
Description :  Checks whether a resource exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource to check. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The resource provider of the resource to check. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to check whether it exists. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Resources_Delete (removed)
Description :  Deletes a resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource to delete. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Resources_CreateOrUpdate (removed)
Description :  Creates a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group for the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to create. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating or updating the resource. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}
Resources_Update (removed)
Description :  Updates a resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group for the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to update. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating the resource. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}
Resources_Get (removed)
Description :  Gets a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource to get. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
Resources_CheckExistenceById (removed)
Description :  Checks by ID whether a resource exists.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (404)

{}
Resources_DeleteById (removed)
Description :  Deletes a resource by ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Resources_CreateOrUpdateById (removed)
Description :  Create a resource by ID.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update resource parameters. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}
Resources_UpdateById (removed)
Description :  Updates a resource by ID.
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Update resource parameters. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}
Resources_GetById (removed)
Description :  Gets a resource by ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
Tags_DeleteValue (removed)
Description :  Deletes a tag value.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_CreateOrUpdateValue (removed)
Description :  Creates a tag value. The name of the tag must already exist.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
Tags_CreateOrUpdate (removed)
Description :  The tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You cannot create tags with one of these prefixes.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
Tags_Delete (removed)
Description :  You must remove all values from a resource tag before you can delete it.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_List (removed)
Description :  Gets the names and values of all resource tags that are defined in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/tagNames
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of tags. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}