Skip to content

Commit 12653ac

Browse files
author
VSC CI Service
committed
Update Document Content
1 parent a481a6b commit 12653ac

File tree

483 files changed

+16116
-14
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

483 files changed

+16116
-14
lines changed

2017-03-09-profile/docs-ref-autogen/account.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ items:
33
- uid: az_account
44
name: az account
55
summary: Manage subscriptions.
6+
description: ''
67
langs:
78
- azurecli
89
children:
@@ -15,6 +16,7 @@ items:
1516
- uid: az_account_clear
1617
name: az account clear
1718
summary: Clear all subscriptions from the CLI's local cache.
19+
description: To clear the current subscription, use 'az logout'.
1820
langs:
1921
- azurecli
2022
parameters: []
@@ -27,13 +29,16 @@ items:
2729
- uid: az_account_get_access_token
2830
name: az account get-access-token
2931
summary: Get AAD token to access to a specified resource.
32+
description: Provides the token for trusted utils to access your Azure subscriptions. The token will be valid for at least 5 minutes with the maximum at 60 minutes. If the subscription argument isn't specified, the current account is used.
3033
langs:
3134
- azurecli
3235
parameters:
3336
- name: --resource
3437
summary: Azure resource endpoints. Default to Azure Resource Manager Use 'az cloud show' command for other Azure resources.
38+
description: ''
3539
- name: --subscription -s
3640
summary: Name or ID of subscription.
41+
description: ''
3742
source:
3843
path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
3944
remote:
@@ -43,13 +48,16 @@ items:
4348
- uid: az_account_list
4449
name: az account list
4550
summary: Get a list of subscriptions for the account.
51+
description: ''
4652
langs:
4753
- azurecli
4854
parameters:
4955
- name: --all
5056
summary: List all subscriptions, rather just 'Enabled' ones.
57+
description: ''
5158
- name: --refresh
5259
summary: Retrieve up to date subscriptions from server.
60+
description: ''
5361
source:
5462
path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
5563
remote:
@@ -59,6 +67,7 @@ items:
5967
- uid: az_account_list_locations
6068
name: az account list-locations
6169
summary: List supported regions of the current subscription.
70+
description: ''
6271
langs:
6372
- azurecli
6473
parameters: []
@@ -71,12 +80,14 @@ items:
7180
- uid: az_account_set
7281
name: az account set
7382
summary: Set a subscription as the current subscription.
83+
description: ''
7484
langs:
7585
- azurecli
7686
parameters:
7787
- isRequired: true
7888
name: --subscription -s
7989
summary: Name or ID of subscription.
90+
description: ''
8091
source:
8192
path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
8293
remote:
@@ -86,13 +97,16 @@ items:
8697
- uid: az_account_show
8798
name: az account show
8899
summary: Show the details of a subscription.
100+
description: If the subscription isn't specified, shows the details of the default subscription.
89101
langs:
90102
- azurecli
91103
parameters:
92104
- name: --sdk-auth
93105
summary: Output result in compatible with Azure SDK auth file.
106+
description: ''
94107
- name: --subscription -s
95108
summary: Name or ID of subscription.
109+
description: ''
96110
source:
97111
path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
98112
remote:
@@ -131,3 +145,9 @@ globalParameters:
131145
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
132146
- name: --verbose
133147
summary: Increase logging verbosity. Use --debug for full debug logs.
148+
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
149+
doc_source_url_path: src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
150+
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
151+
gitcommit: https://github.com/Azure/azure-cli/blob/2b6a49180f52618c2718eeca44563561cdfede0a/src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py
152+
updated_at: 7/13/2017 7:24:10 PM
153+
ms.date: 7/13/2017

2017-03-09-profile/docs-ref-autogen/cloud.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ items:
33
- uid: az_cloud
44
name: az cloud
55
summary: Manage the registered Azure clouds.
6+
description: ''
67
langs:
78
- azurecli
89
children:
@@ -16,6 +17,7 @@ items:
1617
- uid: az_cloud_list
1718
name: az cloud list
1819
summary: List the registered clouds.
20+
description: ''
1921
langs:
2022
- azurecli
2123
parameters: []
@@ -28,14 +30,17 @@ items:
2830
- uid: az_cloud_list_profiles
2931
name: az cloud list-profiles
3032
summary: List the profiles a given cloud supports.
33+
description: ''
3134
langs:
3235
- azurecli
3336
parameters:
3437
- name: --name -n
3538
defaultValue: AzureCloud
3639
summary: Name of a registered cloud.
40+
description: ''
3741
- name: --show-all
3842
summary: Show all available profiles supported in the CLI.
43+
description: ''
3944
source:
4045
path: src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
4146
remote:
@@ -45,45 +50,63 @@ items:
4550
- uid: az_cloud_register
4651
name: az cloud register
4752
summary: Register a cloud.
53+
description: When registering a cloud, specify only the resource manager endpoint for the autodetection of other endpoints.
4854
langs:
4955
- azurecli
5056
parameters:
5157
- isRequired: true
5258
name: --name -n
5359
summary: Name of a registered cloud.
60+
description: ''
5461
- name: --cloud-config
5562
summary: JSON encoded cloud configuration. Use @{file} to load from a file.
63+
description: ''
5664
- name: --endpoint-active-directory
5765
summary: The Active Directory login endpoint.
66+
description: ''
5867
- name: --endpoint-active-directory-data-lake-resource-id
5968
summary: The Active Directory resource ID for data lake services.
69+
description: ''
6070
- name: --endpoint-active-directory-graph-resource-id
6171
summary: The Active Directory resource ID.
72+
description: ''
6273
- name: --endpoint-active-directory-resource-id
6374
summary: The resource ID to obtain AD tokens for.
75+
description: ''
6476
- name: --endpoint-gallery
6577
summary: The template gallery endpoint.
78+
description: ''
6679
- name: --endpoint-management
6780
summary: The management service endpoint.
81+
description: ''
6882
- name: --endpoint-resource-manager
6983
summary: The resource management endpoint.
84+
description: ''
7085
- name: --endpoint-sql-management
7186
summary: The sql server management endpoint.
87+
description: ''
7288
- name: --endpoint-vm-image-alias-doc
7389
summary: The uri of the document which caches commonly used virtual machine images.
90+
description: ''
7491
- name: --profile
7592
parameterValueGroup: 2017-03-09-profile, latest
7693
summary: Profile to use for this cloud.
94+
description: ''
7795
- name: --suffix-azure-datalake-analytics-catalog-and-job-endpoint
7896
summary: The Data Lake analytics job and catalog service dns suffix.
97+
description: ''
7998
- name: --suffix-azure-datalake-store-file-system-endpoint
8099
summary: The Data Lake store filesystem service dns suffix.
100+
description: ''
81101
- name: --suffix-keyvault-dns
82102
summary: The Key Vault service dns suffix.
103+
description: ''
83104
- name: --suffix-sql-server-hostname
84105
summary: The dns suffix for sql servers.
106+
description: ''
85107
- name: --suffix-storage-endpoint
86108
summary: The endpoint suffix for storage accounts.
109+
description: ''
87110
source:
88111
path: src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
89112
remote:
@@ -93,15 +116,18 @@ items:
93116
- uid: az_cloud_set
94117
name: az cloud set
95118
summary: Set the active cloud.
119+
description: ''
96120
langs:
97121
- azurecli
98122
parameters:
99123
- isRequired: true
100124
name: --name -n
101125
summary: Name of a registered cloud.
126+
description: ''
102127
- name: --profile
103128
parameterValueGroup: 2017-03-09-profile, latest
104129
summary: Profile to use for this cloud.
130+
description: ''
105131
source:
106132
path: src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
107133
remote:
@@ -111,12 +137,14 @@ items:
111137
- uid: az_cloud_show
112138
name: az cloud show
113139
summary: Show the configuration of a registered cloud.
140+
description: ''
114141
langs:
115142
- azurecli
116143
parameters:
117144
- name: --name -n
118145
defaultValue: AzureCloud
119146
summary: Name of a registered cloud.
147+
description: ''
120148
source:
121149
path: src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
122150
remote:
@@ -126,12 +154,14 @@ items:
126154
- uid: az_cloud_unregister
127155
name: az cloud unregister
128156
summary: Unregister a cloud.
157+
description: ''
129158
langs:
130159
- azurecli
131160
parameters:
132161
- isRequired: true
133162
name: --name -n
134163
summary: Name of a registered cloud.
164+
description: ''
135165
source:
136166
path: src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
137167
remote:
@@ -141,45 +171,63 @@ items:
141171
- uid: az_cloud_update
142172
name: az cloud update
143173
summary: Update the configuration for a cloud.
174+
description: ''
144175
langs:
145176
- azurecli
146177
parameters:
147178
- name: --cloud-config
148179
summary: JSON encoded cloud configuration. Use @{file} to load from a file.
180+
description: ''
149181
- name: --endpoint-active-directory
150182
summary: The Active Directory login endpoint.
183+
description: ''
151184
- name: --endpoint-active-directory-data-lake-resource-id
152185
summary: The Active Directory resource ID for data lake services.
186+
description: ''
153187
- name: --endpoint-active-directory-graph-resource-id
154188
summary: The Active Directory resource ID.
189+
description: ''
155190
- name: --endpoint-active-directory-resource-id
156191
summary: The resource ID to obtain AD tokens for.
192+
description: ''
157193
- name: --endpoint-gallery
158194
summary: The template gallery endpoint.
195+
description: ''
159196
- name: --endpoint-management
160197
summary: The management service endpoint.
198+
description: ''
161199
- name: --endpoint-resource-manager
162200
summary: The resource management endpoint.
201+
description: ''
163202
- name: --endpoint-sql-management
164203
summary: The sql server management endpoint.
204+
description: ''
165205
- name: --endpoint-vm-image-alias-doc
166206
summary: The uri of the document which caches commonly used virtual machine images.
207+
description: ''
167208
- name: --name -n
168209
defaultValue: AzureCloud
169210
summary: Name of a registered cloud.
211+
description: ''
170212
- name: --profile
171213
parameterValueGroup: 2017-03-09-profile, latest
172214
summary: Profile to use for this cloud.
215+
description: ''
173216
- name: --suffix-azure-datalake-analytics-catalog-and-job-endpoint
174217
summary: The Data Lake analytics job and catalog service dns suffix.
218+
description: ''
175219
- name: --suffix-azure-datalake-store-file-system-endpoint
176220
summary: The Data Lake store filesystem service dns suffix.
221+
description: ''
177222
- name: --suffix-keyvault-dns
178223
summary: The Key Vault service dns suffix.
224+
description: ''
179225
- name: --suffix-sql-server-hostname
180226
summary: The dns suffix for sql servers.
227+
description: ''
181228
- name: --suffix-storage-endpoint
182229
summary: The endpoint suffix for storage accounts.
230+
description: ''
183231
source:
184232
path: src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
185233
remote:
@@ -221,3 +269,9 @@ globalParameters:
221269
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
222270
- name: --verbose
223271
summary: Increase logging verbosity. Use --debug for full debug logs.
272+
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
273+
doc_source_url_path: src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
274+
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
275+
gitcommit: https://github.com/Azure/azure-cli/blob/b312a984232123ec09025f768a8068b076c75bb6/src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py
276+
updated_at: 6/23/2017 5:24:06 PM
277+
ms.date: 6/23/2017

2017-03-09-profile/docs-ref-autogen/component.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ items:
33
- uid: az_component
44
name: az component
55
summary: Manage and update Azure CLI 2.0 components.
6+
description: ''
67
langs:
78
- azurecli
89
children:
@@ -13,6 +14,7 @@ items:
1314
- uid: az_component_list
1415
name: az component list
1516
summary: List the installed components of Azure CLI 2.0.
17+
description: ''
1618
langs:
1719
- azurecli
1820
parameters: []
@@ -25,6 +27,7 @@ items:
2527
- uid: az_component_list_available
2628
name: az component list-available
2729
summary: List publicly available components that can be installed.
30+
description: ''
2831
langs:
2932
- azurecli
3033
parameters: []
@@ -37,12 +40,14 @@ items:
3740
- uid: az_component_remove
3841
name: az component remove
3942
summary: Remove a component from Azure CLI 2.0.
43+
description: ''
4044
langs:
4145
- azurecli
4246
parameters:
4347
- isRequired: true
4448
name: --name -n
4549
summary: Name of component.
50+
description: ''
4651
source:
4752
path: src/command_modules/azure-cli-component/azure/cli/command_modules/component/_help.py
4853
remote:
@@ -52,19 +57,25 @@ items:
5257
- uid: az_component_update
5358
name: az component update
5459
summary: Update Azure CLI 2.0 and all of the installed components.
60+
description: ''
5561
langs:
5662
- azurecli
5763
parameters:
5864
- name: --add
5965
summary: The names of additional components to install (space separated).
66+
description: ''
6067
- name: --allow-third-party
6168
summary: Allow installation of 3rd party command modules. This option is assumed with --private.
69+
description: ''
6270
- name: --link -l
6371
summary: If a url or path to an html file, parse for links to archives. If local path or file:// url that's a directory, then look for archives in the directory listing.
72+
description: ''
6473
- name: --pre
6574
summary: Include pre-release versions.
75+
description: ''
6676
- name: --private
6777
summary: Include packages from a private server.
78+
description: ''
6879
source:
6980
path: src/command_modules/azure-cli-component/azure/cli/command_modules/component/_help.py
7081
remote:
@@ -97,3 +108,9 @@ globalParameters:
97108
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
98109
- name: --verbose
99110
summary: Increase logging verbosity. Use --debug for full debug logs.
111+
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
112+
doc_source_url_path: src/command_modules/azure-cli-component/azure/cli/command_modules/component/_help.py
113+
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-component/azure/cli/command_modules/component/_help.py
114+
gitcommit: https://github.com/Azure/azure-cli/blob/85d95913a0147f318ef9f75dcd110ec03e9e172b/src/command_modules/azure-cli-component/azure/cli/command_modules/component/_help.py
115+
updated_at: 5/9/2017 7:03:04 PM
116+
ms.date: 5/9/2017

0 commit comments

Comments
 (0)