{resourceProviderNamespace} (stable:2016-07-01)

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

Providers_Unregister (new)
Description :  Unregisters provider from a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the 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 in. ,
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 ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_Register (new)
Description :  Registers provider to be used with a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the 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 in. ,
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 ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_List (new)
Description :  Gets a list of resource providers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers
{
$top:
{
Description: Query parameters. If null is passed returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
$expand:
{
Description: The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resource providers. ,
Required: False ,
}
[
{
id:
{
Description: The provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the 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 in. ,
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 ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
Providers_Get (new)
Description :  Gets a resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
{
$expand:
{
Description: The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the 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 in. ,
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 ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
ResourceGroups_ListResources (new)
Description :  Get all of the resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources
{
resourceGroupName:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
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: Query parameters. If null is passed returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list 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 get the next set of results. ,
Required: True ,
}
string ,
}
ResourceGroups_CheckExistence (new)
Description :  Checks whether 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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
ResourceGroups_CreateOrUpdate (new)
Description :  Create a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update resource group service operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
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 ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Delete (new)
Description :  Delete resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be deleted. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
ResourceGroups_Get (new)
Description :  Get 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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Patch (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 groups, though if a field is unspecified current value will be carried over.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be created or updated. The name is case insensitive. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update state resource group service operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
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 ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
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 be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the export template resource group operation. ,
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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 from the server. ,
Required: True ,
}
string ,
message:
{
Description: The error message returned from the server. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Validation error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ResourceGroups_List (new)
Description :  Gets a collection of resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list 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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: True ,
}
string ,
}
Resources_MoveResources (new)
Description :  Move resources from one resource group to another. The resources being moved should all be in the same resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources
{
sourceResourceGroupName:
{
Description: Source resource group name. ,
Required: True ,
}
string ,
parameters:
{
Description: move resources' parameters. ,
Required: True ,
}
{
resources:
{
Description: The ids of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resources
{
$filter:
{
Description: The filter to apply on the operation. ,
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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list 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 get the next set of results. ,
Required: True ,
}
string ,
}
Resources_CheckExistence (new)
Description :  Checks whether resource exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Description: Api version to use. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Resources_Delete (new)
Description :  Delete resource and all of its resources.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Description: Api version to use. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Description: Api version to use. ,
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}
Resources_Get (new)
Description :  Returns a resource belonging to a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Description: Api version to use. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
Tags_DeleteValue (new)
Description :  Delete a subscription resource 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_CreateOrUpdateValue (new)
Description :  Create a subscription resource tag value.
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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
string ,
}
,
}

⚐ 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 ,
}
string ,
}
,
}
Tags_CreateOrUpdate (new)
Description :  Create a subscription resource tag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
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 ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
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 ,
}
string ,
}
,
}
,
]
,
}
Tags_Delete (new)
Description :  Delete a subscription resource tag.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_List (new)
Description :  Get a list of subscription resource tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/tagNames
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of tags. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
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 ,
}
string ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: True ,
}
string ,
}
Providers_Unregister (removed)
Description :  Unregisters provider from a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the 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 in. ,
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 ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_Register (removed)
Description :  Registers provider to be used with a subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register
{
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the 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 in. ,
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 ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
Providers_List (removed)
Description :  Gets a list of resource providers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers
{
$top:
{
Description: Query parameters. If null is passed returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
$expand:
{
Description: The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resource providers. ,
Required: False ,
}
[
{
id:
{
Description: The provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the 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 in. ,
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 ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
Providers_Get (removed)
Description :  Gets a resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
{
$expand:
{
Description: The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: Namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider id. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the 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 in. ,
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 ,
]
,
}
,
]
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
}
ResourceGroups_ListResources (removed)
Description :  Get all of the resources under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources
{
resourceGroupName:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
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: Query parameters. If null is passed returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list 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 get the next set of results. ,
Required: True ,
}
string ,
}
ResourceGroups_CheckExistence (removed)
Description :  Checks whether 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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
ResourceGroups_CreateOrUpdate (removed)
Description :  Create a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update resource group service operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
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 ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Delete (removed)
Description :  Delete resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be deleted. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
ResourceGroups_Get (removed)
Description :  Get 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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
ResourceGroups_Patch (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 groups, though if a field is unspecified current value will be carried over.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to be created or updated. The name is case insensitive. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update state resource group service operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
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 ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
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 be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the export template resource group operation. ,
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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 from the server. ,
Required: True ,
}
string ,
message:
{
Description: The error message returned from the server. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Validation error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ResourceGroups_List (removed)
Description :  Gets a collection of resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: Query parameters. If null is passed returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list 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 ,
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. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. ,
Required: True ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: True ,
}
string ,
}
Resources_MoveResources (removed)
Description :  Move resources from one resource group to another. The resources being moved should all be in the same resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources
{
sourceResourceGroupName:
{
Description: Source resource group name. ,
Required: True ,
}
string ,
parameters:
{
Description: move resources' parameters. ,
Required: True ,
}
{
resources:
{
Description: The ids of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resources
{
$filter:
{
Description: The filter to apply on the operation. ,
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: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list 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 get the next set of results. ,
Required: True ,
}
string ,
}
Resources_CheckExistence (removed)
Description :  Checks whether resource exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Description: Api version to use. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Resources_Delete (removed)
Description :  Delete resource and all of its resources.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Description: Api version to use. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Description: Api version to use. ,
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}
Resources_Get (removed)
Description :  Returns a resource belonging to a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource identity. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: Resource identity. ,
Required: True ,
}
string ,
resourceName:
{
Description: Resource identity. ,
Required: True ,
}
string ,
api-version:
{
Description: Api version to use. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
}
,
}
Tags_DeleteValue (removed)
Description :  Delete a subscription resource 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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_CreateOrUpdateValue (removed)
Description :  Create a subscription resource tag value.
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. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
string ,
}
,
}

⚐ 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 ,
}
string ,
}
,
}
Tags_CreateOrUpdate (removed)
Description :  Create a subscription resource tag.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
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 ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
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 ,
}
string ,
}
,
}
,
]
,
}
Tags_Delete (removed)
Description :  Delete a subscription resource tag.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Tags_List (removed)
Description :  Get a list of subscription resource tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/tagNames
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of tags. ,
Required: False ,
}
[
{
id:
{
Description: The tag ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The tag count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
string ,
}
,
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 ,
}
string ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: True ,
}
string ,
}