SubscriptionClient Class

All resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Inheritance

azure.mgmt.resource.subscriptions._operations_mixin.SubscriptionClientOperationsMixin

SubscriptionClient

MultiApiClientMixin

SubscriptionClient

azure.mgmt.resource.subscriptions._subscription_client._SDKClient

SubscriptionClient

Constructor

SubscriptionClient(credential: TokenCredential, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)

Parameters

Name	Description
credential Required	TokenCredential Credential needed for the client to connect to Azure. Required.
api_version	str API version to use if no profile is provided, or if missing in profile. default value: None
base_url	str Service URL default value: https://management.azure.com
profile	KnownProfiles A profile definition, from KnownProfiles to dict. default value: KnownProfiles.default

Methods

close
models	Module depends on the API version: 2016-06-01: models 2018-06-01: models 2019-06-01: models 2019-11-01: models 2021-01-01: models 2022-12-01: models

close

close()

models

Module depends on the API version:

• 2016-06-01: models

• 2018-06-01: models

• 2019-06-01: models

• 2019-11-01: models

• 2021-01-01: models

• 2022-12-01: models

models(api_version='2022-12-01')

Parameters

Name	Description
api_version	default value: 2022-12-01

Attributes

operations

Instance depends on the API version:

• 2016-06-01: Operations

• 2018-06-01: Operations

• 2019-06-01: Operations

• 2019-11-01: Operations

• 2022-12-01: Operations

subscriptions

Instance depends on the API version:

• 2016-06-01: SubscriptionsOperations

• 2018-06-01: SubscriptionsOperations

• 2019-06-01: SubscriptionsOperations

• 2019-11-01: SubscriptionsOperations

• 2021-01-01: SubscriptionsOperations

• 2022-12-01: SubscriptionsOperations

tenants

Instance depends on the API version:

• 2016-06-01: TenantsOperations

• 2018-06-01: TenantsOperations

• 2019-06-01: TenantsOperations

• 2019-11-01: TenantsOperations

• 2021-01-01: TenantsOperations

• 2022-12-01: TenantsOperations

DEFAULT_API_VERSION

DEFAULT_API_VERSION = '2022-12-01'

LATEST_PROFILE

LATEST_PROFILE = azure.mgmt.resource.subscriptions.SubscriptionClient latest