Skip to content

Commit 7ff96d9

Browse files
author
maddieclayton
authored
Merge pull request Azure#4978 from darshanhs90/helpgen
update help docs
2 parents 70450b7 + f6c0c58 commit 7ff96d9

File tree

6 files changed

+23
-19
lines changed

6 files changed

+23
-19
lines changed

src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADAppCredential.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Adds a credential to an existing application.
1515

1616
### ApplicationObjectIdWithPasswordParameterSet (Default)
1717
```
18-
New-AzureRmADAppCredential -ObjectId <String> -Password <String> [-StartDate <DateTime>] [-EndDate <DateTime>]
18+
New-AzureRmADAppCredential -ObjectId <String> -Password <SecureString> [-StartDate <DateTime>] [-EndDate <DateTime>]
1919
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

@@ -33,7 +33,7 @@ New-AzureRmADAppCredential -ApplicationId <String> -CertValue <String> [-StartDa
3333

3434
### ApplicationIdWithPasswordParameterSet
3535
```
36-
New-AzureRmADAppCredential -ApplicationId <String> -Password <String> [-StartDate <DateTime>]
36+
New-AzureRmADAppCredential -ApplicationId <String> -Password <SecureString> [-StartDate <DateTime>]
3737
[-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3838
```
3939

@@ -45,7 +45,8 @@ The application is identified by supplying either the application object id or a
4545

4646
### -------------------------- Example 1 --------------------------
4747
```
48-
PS E:\> New-AzureRmADAppCredential -ObjectId 1f89cf81-0146-4f4e-beae-2007d0668416 -Password P@ssw0rd!
48+
PS E:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force
49+
PS E:\> New-AzureRmADAppCredential -ObjectId 1f89cf81-0146-4f4e-beae-2007d0668416 -Password $SecureStringPassword
4950
```
5051

5152
A new password credential is added to an existing application.
@@ -156,7 +157,7 @@ Accept wildcard characters: False
156157
The password to be associated with the application.
157158
158159
```yaml
159-
Type: String
160+
Type: SecureString
160161
Parameter Sets: ApplicationObjectIdWithPasswordParameterSet, ApplicationIdWithPasswordParameterSet
161162
Aliases:
162163

src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADApplication.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-Home
2323
### ApplicationWithPasswordPlainParameterSet
2424
```
2525
New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>]
26-
[-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -Password <String> [-StartDate <DateTime>]
26+
[-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -Password <SecureString> [-StartDate <DateTime>]
2727
[-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2828
```
2929

@@ -62,8 +62,9 @@ Creates a new azure active directory application without any credentials.
6262

6363
### -------------------------- Create new AAD application with password. --------------------------
6464
```
65+
PS E:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force
6566
PS C:\> New-AzureRmADApplication -DisplayName "NewApplication" -HomePage "http://www.microsoft.com" -IdentifierUris "http:
66-
//NewApplication" -Password "password"
67+
//NewApplication" -Password $SecureStringPassword
6768
```
6869

6970
Creates a new azure active directory application and associates password credentials with it.
@@ -197,7 +198,7 @@ Accept wildcard characters: False
197198
The password to be associated with the application.
198199
199200
```yaml
200-
Type: String
201+
Type: SecureString
201202
Parameter Sets: ApplicationWithPasswordPlainParameterSet
202203
Aliases:
203204

src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADServicePrincipal.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ New-AzureRmADServicePrincipal -ApplicationId <Guid> [-DefaultProfile <IAzureCont
2121

2222
### ApplicationWithPasswordPlainParameterSet
2323
```
24-
New-AzureRmADServicePrincipal -ApplicationId <Guid> -Password <String> [-StartDate <DateTime>]
24+
New-AzureRmADServicePrincipal -ApplicationId <Guid> -Password <SecureString> [-StartDate <DateTime>]
2525
[-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2626
```
2727

@@ -51,7 +51,7 @@ New-AzureRmADServicePrincipal -DisplayName <String> [-DefaultProfile <IAzureCont
5151

5252
### DisplayNameWithPasswordPlainParameterSet
5353
```
54-
New-AzureRmADServicePrincipal -DisplayName <String> -Password <String> [-StartDate <DateTime>]
54+
New-AzureRmADServicePrincipal -DisplayName <String> -Password <SecureString> [-StartDate <DateTime>]
5555
[-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
5656
```
5757

@@ -94,7 +94,8 @@ DemoApp ServicePrincipal f95b6f5c-fc98-4af0
9494

9595
### -------------------------- Example 2 --------------------------
9696
```
97-
New-AzureRmADServicePrincipal -DisplayName SPForNoExistingApp
97+
$SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force
98+
New-AzureRmADServicePrincipal -DisplayName SPForNoExistingApp -Password $SecureStringPassword
9899
```
99100

100101
Creates a new service principal.
@@ -205,7 +206,7 @@ Accept wildcard characters: False
205206
The password to be associated with the service principal.
206207
207208
```yaml
208-
Type: String
209+
Type: SecureString
209210
Parameter Sets: ApplicationWithPasswordPlainParameterSet, DisplayNameWithPasswordPlainParameterSet
210211
Aliases:
211212

src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADSpCredential.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Adds a credential to an existing service principal.
1515

1616
### SpObjectIdWithPasswordParameterSet (Default)
1717
```
18-
New-AzureRmADSpCredential -ObjectId <String> -Password <String> [-StartDate <DateTime>] [-EndDate <DateTime>]
18+
New-AzureRmADSpCredential -ObjectId <String> -Password <SecureString> [-StartDate <DateTime>] [-EndDate <DateTime>]
1919
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

@@ -33,7 +33,7 @@ New-AzureRmADSpCredential -ServicePrincipalName <String> -CertValue <String> [-S
3333

3434
### SPNWithPasswordParameterSet
3535
```
36-
New-AzureRmADSpCredential -ServicePrincipalName <String> -Password <String> [-StartDate <DateTime>]
36+
New-AzureRmADSpCredential -ServicePrincipalName <String> -Password <SecureString> [-StartDate <DateTime>]
3737
[-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3838
```
3939

@@ -45,7 +45,8 @@ The service principal is identified by supplying either the object id or service
4545

4646
### -------------------------- Example 1 --------------------------
4747
```
48-
PS E:\> New-AzureRmADSpCredential -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 -Password "P@ssw0rd!"
48+
PS E:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force
49+
PS E:\> New-AzureRmADSpCredential -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 -Password $SecureStringPassword
4950
```
5051

5152
A new password credential is added to an existing service principal.
@@ -149,7 +150,7 @@ Accept wildcard characters: False
149150
The password to be associated with the application.
150151
151152
```yaml
152-
Type: String
153+
Type: SecureString
153154
Parameter Sets: SpObjectIdWithPasswordParameterSet, SPNWithPasswordParameterSet
154155
Aliases:
155156

src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADUser.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Creates a new active directory user.
1414
## SYNTAX
1515

1616
```
17-
New-AzureRmADUser -DisplayName <String> -UserPrincipalName <String> -Password <String> [-ImmutableId <String>]
17+
New-AzureRmADUser -DisplayName <String> -UserPrincipalName <String> -Password <SecureString> [-ImmutableId <String>]
1818
[-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
1919
[<CommonParameters>]
2020
```
@@ -102,7 +102,7 @@ It must meet the tenant's password complexity requirements.
102102
It is recommended to set a strong password.
103103
104104
```yaml
105-
Type: String
105+
Type: SecureString
106106
Parameter Sets: (All)
107107
Aliases:
108108

src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADUser.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Updates an existing active directory user.
1515

1616
```
1717
Set-AzureRmADUser -UPNOrObjectId <String> [-DisplayName <String>] [-EnableAccount <Boolean>]
18-
[-Password <String>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
18+
[-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
1919
[-Confirm] [<CommonParameters>]
2020
```
2121

@@ -104,7 +104,7 @@ It must meet the tenant's password complexity requirements.
104104
It is recommended to set a strong password.
105105
106106
```yaml
107-
Type: String
107+
Type: SecureString
108108
Parameter Sets: (All)
109109
Aliases:
110110

0 commit comments

Comments
 (0)