-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.mgmt.resource.SubscriptionClient.yml
100 lines (92 loc) · 5.59 KB
/
azure.mgmt.resource.SubscriptionClient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
### YamlMime:PythonClass
uid: azure.mgmt.resource.SubscriptionClient
name: SubscriptionClient
fullName: azure.mgmt.resource.SubscriptionClient
module: azure.mgmt.resource
inheritances:
- azure.mgmt.resource.subscriptions._operations_mixin.SubscriptionClientOperationsMixin
- azure.profiles.multiapiclient.MultiApiClientMixin
- azure.mgmt.resource.subscriptions._subscription_client._SDKClient
summary: '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.'
constructor:
syntax: 'SubscriptionClient(credential: TokenCredential, api_version: str | None
= None, base_url: str = ''https://management.azure.com'', profile: KnownProfiles
= KnownProfiles.default, **kwargs: Any)'
parameters:
- name: credential
description: Credential needed for the client to connect to Azure. Required.
isRequired: true
types:
- <xref:azure.core.credentials.TokenCredential>
- name: api_version
description: API version to use if no profile is provided, or if missing in profile.
defaultValue: None
types:
- <xref:str>
- name: base_url
description: Service URL
defaultValue: https://management.azure.com
types:
- <xref:str>
- name: profile
description: A profile definition, from KnownProfiles to dict.
defaultValue: KnownProfiles.default
types:
- <xref:azure.profiles.KnownProfiles>
methods:
- uid: azure.mgmt.resource.SubscriptionClient.close
name: close
signature: close()
- uid: azure.mgmt.resource.SubscriptionClient.models
name: models
summary: "Module depends on the API version:\n\n* 2016-06-01: <xref:azure.mgmt.resource.subscriptions.v2016_06_01.models#module-azure.mgmt.resource.subscriptions.v2016_06_01.models>\
\ \n\n* 2018-06-01: <xref:azure.mgmt.resource.subscriptions.v2018_06_01.models#module-azure.mgmt.resource.subscriptions.v2018_06_01.models>\
\ \n\n* 2019-06-01: <xref:azure.mgmt.resource.subscriptions.v2019_06_01.models#module-azure.mgmt.resource.subscriptions.v2019_06_01.models>\
\ \n\n* 2019-11-01: <xref:azure.mgmt.resource.subscriptions.v2019_11_01.models#module-azure.mgmt.resource.subscriptions.v2019_11_01.models>\
\ \n\n* 2021-01-01: <xref:azure.mgmt.resource.subscriptions.v2021_01_01.models#module-azure.mgmt.resource.subscriptions.v2021_01_01.models>\
\ \n\n* 2022-12-01: <xref:azure.mgmt.resource.subscriptions.v2022_12_01.models#module-azure.mgmt.resource.subscriptions.v2022_12_01.models>"
signature: models(api_version='2022-12-01')
parameters:
- name: api_version
defaultValue: '2022-12-01'
attributes:
- uid: azure.mgmt.resource.SubscriptionClient.operations
name: operations
summary: "Instance depends on the API version:\n\n* 2016-06-01: <xref:azure.mgmt.resource.subscriptions.v2016_06_01.operations.Operations>\
\ \n\n* 2018-06-01: <xref:azure.mgmt.resource.subscriptions.v2018_06_01.operations.Operations>\
\ \n\n* 2019-06-01: <xref:azure.mgmt.resource.subscriptions.v2019_06_01.operations.Operations>\
\ \n\n* 2019-11-01: <xref:azure.mgmt.resource.subscriptions.v2019_11_01.operations.Operations>\
\ \n\n* 2022-12-01: <xref:azure.mgmt.resource.subscriptions.v2022_12_01.operations.Operations>"
- uid: azure.mgmt.resource.SubscriptionClient.subscriptions
name: subscriptions
summary: "Instance depends on the API version:\n\n* 2016-06-01: <xref:azure.mgmt.resource.subscriptions.v2016_06_01.operations.SubscriptionsOperations>\
\ \n\n* 2018-06-01: <xref:azure.mgmt.resource.subscriptions.v2018_06_01.operations.SubscriptionsOperations>\
\ \n\n* 2019-06-01: <xref:azure.mgmt.resource.subscriptions.v2019_06_01.operations.SubscriptionsOperations>\
\ \n\n* 2019-11-01: <xref:azure.mgmt.resource.subscriptions.v2019_11_01.operations.SubscriptionsOperations>\
\ \n\n* 2021-01-01: <xref:azure.mgmt.resource.subscriptions.v2021_01_01.operations.SubscriptionsOperations>\
\ \n\n* 2022-12-01: <xref:azure.mgmt.resource.subscriptions.v2022_12_01.operations.SubscriptionsOperations>"
- uid: azure.mgmt.resource.SubscriptionClient.tenants
name: tenants
summary: "Instance depends on the API version:\n\n* 2016-06-01: <xref:azure.mgmt.resource.subscriptions.v2016_06_01.operations.TenantsOperations>\
\ \n\n* 2018-06-01: <xref:azure.mgmt.resource.subscriptions.v2018_06_01.operations.TenantsOperations>\
\ \n\n* 2019-06-01: <xref:azure.mgmt.resource.subscriptions.v2019_06_01.operations.TenantsOperations>\
\ \n\n* 2019-11-01: <xref:azure.mgmt.resource.subscriptions.v2019_11_01.operations.TenantsOperations>\
\ \n\n* 2021-01-01: <xref:azure.mgmt.resource.subscriptions.v2021_01_01.operations.TenantsOperations>\
\ \n\n* 2022-12-01: <xref:azure.mgmt.resource.subscriptions.v2022_12_01.operations.TenantsOperations>"
- uid: azure.mgmt.resource.SubscriptionClient.DEFAULT_API_VERSION
name: DEFAULT_API_VERSION
signature: DEFAULT_API_VERSION = '2022-12-01'
- uid: azure.mgmt.resource.SubscriptionClient.LATEST_PROFILE
name: LATEST_PROFILE
signature: LATEST_PROFILE = azure.mgmt.resource.subscriptions.SubscriptionClient
latest