SubscriptionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SubscriptionClient's

<xref:subscriptions> attribute.

Inheritance
builtins.object
SubscriptionsOperations

Constructor

SubscriptionsOperations(*args, **kwargs)

Methods

check_zone_peers

Compares a subscriptions logical zone mapping.
get

Gets details about a specified subscription.
list

Gets all subscriptions for a tenant.
list_locations

Gets all available geo-locations.

This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.

check_zone_peers

Compares a subscriptions logical zone mapping.

check_zone_peers(subscription_id: str, parameters: _models.CheckZonePeersRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckZonePeersResult

Parameters

Name Description
subscription_id
Required
str

The ID of the target subscription. Required.
parameters
Required
CheckZonePeersRequest or IO[bytes]

Parameters for checking zone peers. Is either a CheckZonePeersRequest type or a IO[bytes] type. Required.

Returns

Type Description
CheckZonePeersResult

CheckZonePeersResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets details about a specified subscription.

get(subscription_id: str, **kwargs: Any) -> Subscription

Parameters

Name Description
subscription_id
Required
str

The ID of the target subscription. Required.

Returns

Type Description
Subscription

Subscription or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all subscriptions for a tenant.

list(**kwargs: Any) -> Iterable[Subscription]

Returns

Type Description
ItemPaged[Subscription]

An iterator like instance of either Subscription or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_locations

Gets all available geo-locations.

This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.

list_locations(subscription_id: str, include_extended_locations: bool | None = None, **kwargs: Any) -> Iterable[Location]

Parameters

Name Description
subscription_id
Required
str

The ID of the target subscription. Required.
include_extended_locations
Required
bool

Whether to include extended locations. Default value is None.

Returns

Type Description
ItemPaged[Location]

An iterator like instance of either Location or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.resource.subscriptions.v2022_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\subscriptions\\v2022_12_01\\models\\__init__.py'>