SubscriptionClient (stable:2015-11-01)

2025/12/05 • 6 new methods

Subscriptions_ListLocations (new)
Description :  Gets a list of the subscription locations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/locations
{
subscriptionId:
{
Description: Id of the subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the locations. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the resource (/subscriptions/SubscriptionId). ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets or sets the subscription Id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the location name ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the display name of the location ,
Required: False ,
}
string ,
latitude:
{
Description: Gets or sets the latitude of the location ,
Required: False ,
}
string ,
longitude:
{
Description: Gets or sets the longitude of the location ,
Required: False ,
}
string ,
}
,
]
,
}
Subscriptions_Get (new)
Description :  Gets details about particular subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}
{
subscriptionId:
{
Description: Id of the subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the ID of the resource (/subscriptions/SubscriptionId). ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets or sets the subscription Id. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the subscription display name ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the subscription state ,
Required: False ,
}
string ,
subscriptionPolicies:
{
Description: Gets or sets the subscription policies. ,
Required: False ,
}
{
locationPlacementId:
{
Description: Gets or sets the subscription location placement Id. ,
Required: False ,
}
string ,
quotaId:
{
Description: Gets or sets the subscription quota Id. ,
Required: False ,
}
string ,
}
,
}
Subscriptions_List (new)
Description :  Gets a list of the subscriptionIds.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets subscriptions. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the resource (/subscriptions/SubscriptionId). ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets or sets the subscription Id. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets or sets the subscription display name ,
Required: False ,
}
string ,
state:
{
Description: Gets or sets the subscription state ,
Required: False ,
}
string ,
subscriptionPolicies:
{
Description: Gets or sets the subscription policies. ,
Required: False ,
}
{
locationPlacementId:
{
Description: Gets or sets the subscription location placement Id. ,
Required: False ,
}
string ,
quotaId:
{
Description: Gets or sets the subscription quota Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
Tenants_List (new)
Description :  Gets a list of the tenantIds.
Reference :  Link ¶

⚼ Request

GET:  /tenants
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets tenant Ids. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets tenantId ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the URL to get the next set of results. ,
Required: True ,
}
string ,
}
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: Client Api Version. ,
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: Client Api Version. ,
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: The error details. ,
Required: False ,
}
{
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
code:
{
Description: Code of the error. ,
Required: False ,
}
string ,
}
,
}