# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------
from azure.mgmt.core import ARMPipelineClient
from msrest import Serializer, Deserializer
from azure.profiles import KnownProfiles, ProfileDefinition
from azure.profiles.multiapiclient import MultiApiClientMixin
from ._configuration import SubscriptionClientConfiguration
from ._operations_mixin import SubscriptionClientOperationsMixin
class _SDKClient(object):
def __init__(self, *args, **kwargs):
"""This is a fake class to support current implemetation of MultiApiClientMixin."
Will be removed in final version of multiapi azure-core based client
"""
pass
[docs]class SubscriptionClient(SubscriptionClientOperationsMixin, MultiApiClientMixin, _SDKClient):
"""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.
:param credential: Credential needed for the client to connect to Azure.
:type credential: ~azure.core.credentials.TokenCredential
:param str api_version: API version to use if no profile is provided, or if
missing in profile.
:param str base_url: Service URL
:param profile: A profile definition, from KnownProfiles to dict.
:type profile: azure.profiles.KnownProfiles
"""
DEFAULT_API_VERSION = '2019-11-01'
_PROFILE_TAG = "azure.mgmt.resource.SubscriptionClient"
LATEST_PROFILE = ProfileDefinition({
_PROFILE_TAG: {
None: DEFAULT_API_VERSION,
}},
_PROFILE_TAG + " latest"
)
def __init__(
self,
credential, # type: "TokenCredential"
api_version=None,
base_url=None,
profile=KnownProfiles.default,
**kwargs # type: Any
):
if not base_url:
base_url = 'https://management.azure.com'
self._config = SubscriptionClientConfiguration(credential, **kwargs)
self._client = ARMPipelineClient(base_url=base_url, config=self._config, **kwargs)
super(SubscriptionClient, self).__init__(
api_version=api_version,
profile=profile
)
@classmethod
def _models_dict(cls, api_version):
return {k: v for k, v in cls.models(api_version).__dict__.items() if isinstance(v, type)}
[docs] @classmethod
def models(cls, api_version=DEFAULT_API_VERSION):
"""Module depends on the API version:
* 2016-06-01: :mod:`v2016_06_01.models<azure.mgmt.resource.v2016_06_01.models>`
* 2018-06-01: :mod:`v2018_06_01.models<azure.mgmt.resource.v2018_06_01.models>`
* 2019-06-01: :mod:`v2019_06_01.models<azure.mgmt.resource.v2019_06_01.models>`
* 2019-11-01: :mod:`v2019_11_01.models<azure.mgmt.resource.v2019_11_01.models>`
"""
if api_version == '2016-06-01':
from .v2016_06_01 import models
return models
elif api_version == '2018-06-01':
from .v2018_06_01 import models
return models
elif api_version == '2019-06-01':
from .v2019_06_01 import models
return models
elif api_version == '2019-11-01':
from .v2019_11_01 import models
return models
raise ValueError("API version {} is not available".format(api_version))
@property
def operations(self):
"""Instance depends on the API version:
* 2016-06-01: :class:`Operations<azure.mgmt.resource.v2016_06_01.operations.Operations>`
* 2018-06-01: :class:`Operations<azure.mgmt.resource.v2018_06_01.operations.Operations>`
* 2019-06-01: :class:`Operations<azure.mgmt.resource.v2019_06_01.operations.Operations>`
* 2019-11-01: :class:`Operations<azure.mgmt.resource.v2019_11_01.operations.Operations>`
"""
api_version = self._get_api_version('operations')
if api_version == '2016-06-01':
from .v2016_06_01.operations import Operations as OperationClass
elif api_version == '2018-06-01':
from .v2018_06_01.operations import Operations as OperationClass
elif api_version == '2019-06-01':
from .v2019_06_01.operations import Operations as OperationClass
elif api_version == '2019-11-01':
from .v2019_11_01.operations import Operations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'operations'".format(api_version))
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)))
@property
def subscriptions(self):
"""Instance depends on the API version:
* 2016-06-01: :class:`SubscriptionsOperations<azure.mgmt.resource.v2016_06_01.operations.SubscriptionsOperations>`
* 2018-06-01: :class:`SubscriptionsOperations<azure.mgmt.resource.v2018_06_01.operations.SubscriptionsOperations>`
* 2019-06-01: :class:`SubscriptionsOperations<azure.mgmt.resource.v2019_06_01.operations.SubscriptionsOperations>`
* 2019-11-01: :class:`SubscriptionsOperations<azure.mgmt.resource.v2019_11_01.operations.SubscriptionsOperations>`
"""
api_version = self._get_api_version('subscriptions')
if api_version == '2016-06-01':
from .v2016_06_01.operations import SubscriptionsOperations as OperationClass
elif api_version == '2018-06-01':
from .v2018_06_01.operations import SubscriptionsOperations as OperationClass
elif api_version == '2019-06-01':
from .v2019_06_01.operations import SubscriptionsOperations as OperationClass
elif api_version == '2019-11-01':
from .v2019_11_01.operations import SubscriptionsOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'subscriptions'".format(api_version))
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)))
@property
def tenants(self):
"""Instance depends on the API version:
* 2016-06-01: :class:`TenantsOperations<azure.mgmt.resource.v2016_06_01.operations.TenantsOperations>`
* 2018-06-01: :class:`TenantsOperations<azure.mgmt.resource.v2018_06_01.operations.TenantsOperations>`
* 2019-06-01: :class:`TenantsOperations<azure.mgmt.resource.v2019_06_01.operations.TenantsOperations>`
* 2019-11-01: :class:`TenantsOperations<azure.mgmt.resource.v2019_11_01.operations.TenantsOperations>`
"""
api_version = self._get_api_version('tenants')
if api_version == '2016-06-01':
from .v2016_06_01.operations import TenantsOperations as OperationClass
elif api_version == '2018-06-01':
from .v2018_06_01.operations import TenantsOperations as OperationClass
elif api_version == '2019-06-01':
from .v2019_06_01.operations import TenantsOperations as OperationClass
elif api_version == '2019-11-01':
from .v2019_11_01.operations import TenantsOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'tenants'".format(api_version))
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)))
[docs] def close(self):
self._client.close()
def __enter__(self):
self._client.__enter__()
return self
def __exit__(self, *exc_details):
self._client.__exit__(*exc_details)