Skip to content

Commit 1a9831f

Browse files
author
VSC CI Service
committed
Update Document Content
1 parent 1b15b79 commit 1a9831f

9 files changed

Lines changed: 65 additions & 55 deletions

File tree

‎docs-ref-autogen/ad.pycliyml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ commandList:
7070
description: ''
7171
href: ad/sp#list
7272
- name: az ad sp reset-credentials
73-
description: Reset credential, on expiration or you forget it.
73+
description: Reset service principal credentials.
7474
href: ad/sp#reset-credentials
7575
- name: az ad sp show
7676
description: ''
@@ -107,6 +107,6 @@ Metadata:
107107
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
108108
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
109109
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
110-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
111-
updated_at: 4/27/2017 6:25:02 PM
112-
ms.date: 4/27/2017
110+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
111+
updated_at: 5/11/2017 5:16:22 PM
112+
ms.date: 5/11/2017

‎docs-ref-autogen/ad/app.pycliyml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,6 @@ Metadata:
335335
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
336336
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
337337
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
338-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
339-
updated_at: 4/27/2017 6:25:02 PM
340-
ms.date: 4/27/2017
338+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
339+
updated_at: 5/11/2017 5:16:22 PM
340+
ms.date: 5/11/2017

‎docs-ref-autogen/ad/group.pycliyml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,6 @@ Metadata:
263263
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
264264
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
265265
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
266-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
267-
updated_at: 4/27/2017 6:25:02 PM
268-
ms.date: 4/27/2017
266+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
267+
updated_at: 5/11/2017 5:16:22 PM
268+
ms.date: 5/11/2017

‎docs-ref-autogen/ad/group/member.pycliyml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,6 @@ Metadata:
203203
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
204204
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
205205
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
206-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
207-
updated_at: 4/27/2017 6:25:02 PM
208-
ms.date: 4/27/2017
206+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
207+
updated_at: 5/11/2017 5:16:22 PM
208+
ms.date: 5/11/2017

‎docs-ref-autogen/ad/sp.pycliyml‎

Lines changed: 40 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ commandList:
1212
description: ''
1313
href: sp#list
1414
- name: az ad sp reset-credentials
15-
description: Reset credential, on expiration or you forget it.
15+
description: Reset service principal credentials.
1616
href: sp#reset-credentials
1717
- name: az ad sp show
1818
description: ''
@@ -79,6 +79,10 @@ children:
7979
code: az ad sp create-for-rbac -n "http://MyApp" --role contributor --scopes /subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup /subscriptions/11111111-2222-3333-4444-666666666666/resourceGroups/MyAnotherResourceGroup
8080
- title: Create using self-signed certificte
8181
code: az ad sp create-for-rbac --create-cert
82+
- title: Create self-signed certificate within KeyVault
83+
code: az ad sp create-for-rbac --key-vault <vault name> --cert <name> --create-cert
84+
- title: Create using existing certificate in KeyVault
85+
code: az ad sp create-for-rbac --key-vault <vault name> --cert <name>
8286
- title: Login with a service principal.
8387
code: az login --service-principal -u <name> -p <password> --tenant <tenant>
8488
- title: Login with self-signed certificate
@@ -89,45 +93,47 @@ children:
8993
code: az role assignment create --assignee <name> --role Contributor
9094
- title: Revoke the service principal when done with it.
9195
code: az ad app delete --id <name>
92-
- title: Create using certificate from Key Vault
93-
code: "az keyvault certificate download --vault-name vault -n cert-name -f cert.pem \n az ad sp create-for-rbac --cert @cert.pem"
9496
parameters:
95-
- name: --cert
96-
isRequired: False
97-
summary: PEM or DER formatted public certificate using string or @<file path> to load from a file. Do not include private key info.
98-
description: ''
99-
- name: --create-cert
100-
isRequired: False
101-
summary: Create and upload self-signed certificate which you can use to login.
102-
description: ''
10397
- name: --expanded-view
10498
isRequired: False
10599
summary: Once created, display more information like subscription and cloud environments.
106100
description: ''
107101
- name: --name -n
108102
isRequired: False
109-
summary: A display name or an app id uri. Command will generate one if missing.
110-
description: ''
111-
- name: --password -p
112-
isRequired: False
113-
summary: The password used to login. If missing, command will generate one.
103+
summary: Display name or an app ID URI. Command will generate one if missing.
114104
description: ''
115105
- name: --role
116106
isRequired: False
117-
summary: Role the service principal has on the resources.
107+
summary: Role the service principal has in regard to resources.
118108
description: ''
119109
defaultValue: Contributor
120110
- name: --scopes
121111
isRequired: False
122-
summary: Space separated scopes the service principal's role assignment applies to. Defaults to the root of the current subscription.
112+
summary: Space-separated list of scopes the service principal's role assignment applies to. Defaults to the root of the current subscription.
123113
description: ''
124114
- name: --skip-assignment
125115
isRequired: False
126116
summary: Do not create default assignment.
127117
description: ''
118+
- name: --cert
119+
isRequired: False
120+
summary: Certificate to use for credentials in lieu of password.
121+
description: When using --key-vault, indicates the name of the cert to use or create. Otherwise, supply a PEM or DER formatted public certificate string. Use @<file path> to load from a file. Do not include private key info.
122+
- name: --create-cert
123+
isRequired: False
124+
summary: Create a self-signed certificate to use for the credential.
125+
description: Use with --key-vault to create the certificate in Key Vault. Otherwise, a certificate will be created locally.
126+
- name: --keyvault
127+
isRequired: False
128+
summary: Name or ID of a KeyVault to use for creating or retrieving certificates.
129+
description: ''
130+
- name: --password -p
131+
isRequired: False
132+
summary: The password used to login. If missing, command will generate one.
133+
description: ''
128134
- name: --years
129135
isRequired: False
130-
summary: 'Years the password will be valid. Default: 1 year.'
136+
summary: 'Number of years for which the credentials will be valid. Default: 1 year.'
131137
description: ''
132138
- name: --debug
133139
isRequired: False
@@ -258,23 +264,27 @@ children:
258264
parameters:
259265
- name: --name -n
260266
isRequired: True
261-
summary: The name, can be the app id uri, app id guid, or display name.
267+
summary: Display name or an app ID URI.
262268
description: ''
263269
- name: --cert
264270
isRequired: False
265-
summary: PEM formatted public certificate. Do not include private key info.
266-
description: ''
271+
summary: Certificate to use for credentials in lieu of password.
272+
description: When using --key-vault, indicates the name of the cert to use or create. Otherwise, supply a PEM or DER formatted public certificate string. Use @<file path> to load from a file. Do not include private key info.
267273
- name: --create-cert
268274
isRequired: False
269-
summary: Re-create and upload self-signed certificate.
275+
summary: Create a self-signed certificate to use for the credential.
276+
description: Use with --key-vault to create the certificate in Key Vault. Otherwise, a certificate will be created locally.
277+
- name: --keyvault
278+
isRequired: False
279+
summary: Name or ID of a KeyVault to use for creating or retrieving certificates.
270280
description: ''
271-
- name: --password
281+
- name: --password -p
272282
isRequired: False
273283
summary: The password used to login. If missing, command will generate one.
274284
description: ''
275285
- name: --years
276286
isRequired: False
277-
summary: 'Years the password will be valid. Default: 1 year.'
287+
summary: 'Number of years for which the credentials will be valid. Default: 1 year.'
278288
description: ''
279289
- name: --debug
280290
isRequired: False
@@ -306,8 +316,8 @@ children:
306316
children: []
307317
uid: az_ad_sp_reset-credentials
308318
name: az ad sp reset-credentials
309-
description: ''
310-
summary: Reset credential, on expiration or you forget it.
319+
description: Use upon expiration of the existing credentials or in the even that you forget them.
320+
summary: Reset service principal credentials.
311321
Metadata: {}
312322
- commandList: []
313323
htmlId: show
@@ -358,6 +368,6 @@ Metadata:
358368
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
359369
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
360370
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
361-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
362-
updated_at: 4/27/2017 6:25:02 PM
363-
ms.date: 4/27/2017
371+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
372+
updated_at: 5/11/2017 5:16:22 PM
373+
ms.date: 5/11/2017

‎docs-ref-autogen/ad/user.pycliyml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,6 @@ Metadata:
219219
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
220220
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
221221
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
222-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
223-
updated_at: 4/27/2017 6:25:02 PM
224-
ms.date: 4/27/2017
222+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
223+
updated_at: 5/11/2017 5:16:22 PM
224+
ms.date: 5/11/2017

‎docs-ref-autogen/role.pycliyml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,6 @@ Metadata:
4444
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
4545
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
4646
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
47-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
48-
updated_at: 4/27/2017 6:25:02 PM
49-
ms.date: 4/27/2017
47+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
48+
updated_at: 5/11/2017 5:16:22 PM
49+
ms.date: 5/11/2017

‎docs-ref-autogen/role/assignment.pycliyml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,6 @@ Metadata:
205205
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
206206
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
207207
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
208-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
209-
updated_at: 4/27/2017 6:25:02 PM
210-
ms.date: 4/27/2017
208+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
209+
updated_at: 5/11/2017 5:16:22 PM
210+
ms.date: 5/11/2017

‎docs-ref-autogen/role/definition.pycliyml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,6 @@ Metadata:
234234
doc_source_url_repo: https://github.com/Azure/azure-cli/blob/master/
235235
doc_source_url_path: src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
236236
original_content_git_url: https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
237-
gitcommit: https://github.com/Azure/azure-cli/blob/0184a166e86690065d6325489ca0490be5f92f4b/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
238-
updated_at: 4/27/2017 6:25:02 PM
239-
ms.date: 4/27/2017
237+
gitcommit: https://github.com/Azure/azure-cli/blob/3e10c0fcee824e3a1d301e99da3299f008be8fee/src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py
238+
updated_at: 5/11/2017 5:16:22 PM
239+
ms.date: 5/11/2017

0 commit comments

Comments
 (0)