SubscriptionClient (stable:2021-01-01)

2025/12/05 • 6 new methods

Subscriptions_ListLocations (new)
Description :  This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/locations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
includeExtendedLocations:
{
Description: Whether to include extended locations. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
value:
{
Description: An array of locations. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
name:
{
Description: The location name. ,
Required: False ,
}
string ,
type:
{
Description: The location type. ,
Enum:
{
Region: No description available. ,
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the location. ,
Required: False ,
}
string ,
regionalDisplayName:
{
Description: The display name of the location and its region. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata of the location, such as lat/long, paired region, and others. ,
Required: False ,
}
{
regionType:
{
Description: The type of the region. ,
Enum:
{
Physical: No description available. ,
Logical: No description available. ,
}
,
Required: False ,
}
enum ,
regionCategory:
{
Description: The category of the region. ,
Enum:
{
Recommended: No description available. ,
Extended: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
geographyGroup:
{
Description: The geography group of the location. ,
Required: False ,
}
string ,
longitude:
{
Description: The longitude of the location. ,
Required: False ,
}
string ,
latitude:
{
Description: The latitude of the location. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: The physical location of the Azure location. ,
Required: False ,
}
string ,
pairedRegion:
{
Description: The regions paired to this region. ,
Required: False ,
}
[
{
name:
{
Description: The name of the paired region. ,
Required: False ,
}
string ,
id:
{
Description: The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
}
,
]
,
homeLocation:
{
Description: The home location of an edge zone. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_Get (new)
Description :  Gets details about a specified subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
displayName:
{
Description: The subscription display name. ,
Required: False ,
}
string ,
tenantId:
{
Description: The subscription tenant ID. ,
Required: False ,
}
string ,
state:
{
Description: The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted. ,
Enum:
{
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionPolicies:
{
Description: The subscription policies. ,
Required: False ,
}
{
locationPlacementId:
{
Description: The subscription location placement ID. The ID indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions. ,
Required: False ,
}
string ,
quotaId:
{
Description: The subscription quota ID. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The subscription spending limit. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
CurrentPeriodOff: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authorizationSource:
{
Description: The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'. ,
Required: False ,
}
string ,
managedByTenants:
{
Description: An array containing the tenants managing the subscription. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant ID of the managing tenant. This is a GUID. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: The tags attached to the subscription. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_List (new)
Description :  Gets all subscriptions for a tenant.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of subscriptions. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
displayName:
{
Description: The subscription display name. ,
Required: False ,
}
string ,
tenantId:
{
Description: The subscription tenant ID. ,
Required: False ,
}
string ,
state:
{
Description: The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted. ,
Enum:
{
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionPolicies:
{
Description: The subscription policies. ,
Required: False ,
}
{
locationPlacementId:
{
Description: The subscription location placement ID. The ID indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions. ,
Required: False ,
}
string ,
quotaId:
{
Description: The subscription quota ID. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The subscription spending limit. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
CurrentPeriodOff: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
authorizationSource:
{
Description: The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'. ,
Required: False ,
}
string ,
managedByTenants:
{
Description: An array containing the tenants managing the subscription. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant ID of the managing tenant. This is a GUID. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: The tags attached to the subscription. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tenants_List (new)
Description :  Gets the tenants for your account.
Reference :  Link ¶

⚼ Request

GET:  /tenants
{
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of tenants. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID. For example, 00000000-0000-0000-0000-000000000000. ,
Required: False ,
}
string ,
tenantCategory:
{
Description: Category of the tenant. ,
Enum:
{
Home: No description available. ,
ProjectedBy: No description available. ,
ManagedBy: No description available. ,
}
,
Required: False ,
}
enum ,
country:
{
Description: Country/region name of the address for the tenant. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country/region abbreviation for the tenant. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the tenant. ,
Required: False ,
}
string ,
domains:
{
Description: The list of domains for the tenant. ,
Required: False ,
}
[
string ,
]
,
defaultDomain:
{
Description: The default domain for the tenant. ,
Required: False ,
}
string ,
tenantType:
{
Description: The tenant type. Only available for 'Home' tenant category. ,
Required: False ,
}
string ,
tenantBrandingLogoUrl:
{
Description: The tenant's branding logo URL. Only available for 'Home' tenant category. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_CheckZonePeers (new)
Description :  Compares a subscriptions logical zone mapping
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/checkZonePeers/
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for checking zone peers. ,
Required: True ,
}
{
location:
{
Description: The Microsoft location. ,
Required: False ,
}
string ,
subscriptionIds:
{
Description: The peer Microsoft Azure subscription ID. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
location:
{
Description: the location of the subscription. ,
Required: False ,
}
string ,
availabilityZonePeers:
{
Description: The Availability Zones shared by the subscriptions. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The availabilityZone. ,
Required: False ,
}
string ,
peers:
{
Description: Details of shared availability zone. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availabilityZone. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
checkResourceName (new)
Description :  A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/checkResourceName
{
Resource Name Definition:
{
Description: Resource object with values for resource name and resource type ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of Resource ,
Required: False ,
}
string ,
type:
{
Description: Type of Resource ,
Required: False ,
}
string ,
status:
{
Description: Is the resource name Allowed or Reserved ,
Enum:
{
Allowed: No description available. ,
Reserved: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}