Skip to content

Commit c647847

Browse files
PramodValavala-MSFTbluewwisra-fel
authored
[Storage] Use official parameters instead of aliases in examples (#17783)
* Use official parameter instead of alias in examples * Update changelog * Update src/Storage/Storage.Management/ChangeLog.md Co-authored-by: Wei Wei <[email protected]> Co-authored-by: Yeming Liu <[email protected]>
1 parent 71932d1 commit c647847

10 files changed

+56
-56
lines changed

src/Storage/Storage.Management/help/Get-AzStorageAccount.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ This command gets all of the Storage accounts in the subscription.
5959

6060
### Example 4: Get a Storage accounts with its blob restore status
6161
```
62-
PS C:\> $account = Get-AzStorageAccount -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount" -IncludeBlobRestoreStatus
62+
PS C:\> $account = Get-AzStorageAccount -ResourceGroupName "myresourcegoup" -Name "mystorageaccount" -IncludeBlobRestoreStatus
6363
6464
PS C:\> $account.BlobRestoreStatus
6565

src/Storage/Storage.Management/help/Get-AzStorageAccountKey.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,23 @@ The **Get-AzStorageAccountKey** cmdlet gets the access keys for an Azure Storage
2525

2626
### Example 1: Get the access keys for a Storage account
2727
```
28-
PS C:\>Get-AzStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount"
28+
PS C:\>Get-AzStorageAccountKey -ResourceGroupName "RG01" -Name "mystorageaccount"
2929
```
3030

3131
This command gets the keys for the specified Azure Storage account.
3232

3333
### Example 2: Get a specific access key for a Storage account
3434
```
3535
This command gets a specific key for a Storage account. This command works for Azure PowerShell version 1.4, and later versions.
36-
PS C:\>(Get-AzStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount")| Where-Object {$_.KeyName -eq "key1"}
36+
PS C:\>(Get-AzStorageAccountKey -ResourceGroupName "RG01" -Name "mystorageaccount")| Where-Object {$_.KeyName -eq "key1"}
3737
3838
This command gets a specific key for a Storage account. This command works for Azure PowerShell version 1.3.2, and previous versions.
39-
PS C:\>(Get-AzStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount").Key1
39+
PS C:\>(Get-AzStorageAccountKey -ResourceGroupName "RG01" -Name "mystorageaccount").Key1
4040
```
4141

4242
### Example 3: Lists the access keys for a Storage account, include the Kerberos keys (if active directory enabled)
4343
```
44-
PS C:\>Get-AzStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount" -ListKerbKey
44+
PS C:\>Get-AzStorageAccountKey -ResourceGroupName "RG01" -Name "mystorageaccount" -ListKerbKey
4545
```
4646

4747
This command gets the keys for the specified Azure Storage account.

src/Storage/Storage.Management/help/Get-AzStorageAccountNetworkRuleSet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The **Get-AzStorageAccountNetworkRuleSet** cmdlet gets the NetworkRule property
2424

2525
### Example 1: Get NetworkRule property of a specified Storage account
2626
```
27-
PS C:\> Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "rg1" -AccountName "mystorageaccount"
27+
PS C:\> Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "rg1" -Name "mystorageaccount"
2828
```
2929

3030
This command gets NetworkRule property of a specified Storage account

src/Storage/Storage.Management/help/Invoke-AzStorageAccountFailover.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ Please understand the following impact to your storage account before you initia
3636

3737
### Example 1: Invoke failover of a Storage account
3838
```
39-
PS C:\>$account = Get-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -IncludeGeoReplicationStats
39+
PS C:\>$account = Get-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -IncludeGeoReplicationStats
4040
PS C:\>$account.GeoReplicationStats
4141
4242
Status LastSyncTime
4343
------ ------------
4444
Live 11/13/2018 2:44:22 AM
4545
46-
PS C:\>$job = Invoke-AzStorageAccountFailover -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Force -AsJob
46+
PS C:\>$job = Invoke-AzStorageAccountFailover -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Force -AsJob
4747
PS C:\>$job | Wait-Job
4848
```
4949

src/Storage/Storage.Management/help/New-AzStorageAccount.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,28 +59,28 @@ The **New-AzStorageAccount** cmdlet creates an Azure Storage account.
5959

6060
### Example 1: Create a Storage account
6161
```powershell
62-
PS C:\>New-AzStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS
62+
PS C:\>New-AzStorageAccount -ResourceGroupName MyResourceGroup -Name mystorageaccount -Location westus -SkuName Standard_GRS
6363
```
6464

6565
This command creates a Storage account for the resource group name MyResourceGroup.
6666

6767
### Example 2: Create a Blob Storage account with BlobStorage Kind and hot AccessTier
6868
```powershell
69-
PS C:\>New-AzStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS -Kind BlobStorage -AccessTier Hot
69+
PS C:\>New-AzStorageAccount -ResourceGroupName MyResourceGroup -Name mystorageaccount -Location westus -SkuName Standard_GRS -Kind BlobStorage -AccessTier Hot
7070
```
7171

7272
This command creates a Blob Storage account that with BlobStorage Kind and hot AccessTier
7373

7474
### Example 3: Create a Storage account with Kind StorageV2, and Generate and Assign an Identity for Azure KeyVault.
7575
```powershell
76-
PS C:\>New-AzStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS -Kind StorageV2 -AssignIdentity
76+
PS C:\>New-AzStorageAccount -ResourceGroupName MyResourceGroup -Name mystorageaccount -Location westus -SkuName Standard_GRS -Kind StorageV2 -AssignIdentity
7777
```
7878

7979
This command creates a Storage account with Kind StorageV2. It also generates and assigns an identity that can be used to manage account keys through Azure KeyVault.
8080

8181
### Example 4: Create a Storage account with NetworkRuleSet from JSON
8282
```powershell
83-
PS C:\>New-AzStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -Type Standard_LRS -NetworkRuleSet (@{bypass="Logging,Metrics";
83+
PS C:\>New-AzStorageAccount -ResourceGroupName MyResourceGroup -Name mystorageaccount -Location westus -Type Standard_LRS -NetworkRuleSet (@{bypass="Logging,Metrics";
8484
ipRules=(@{IPAddressOrRange="20.11.0.0/16";Action="allow"},
8585
@{IPAddressOrRange="10.0.0.0/7";Action="allow"});
8686
virtualNetworkRules=(@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"},
@@ -92,21 +92,21 @@ This command creates a Storage account that has NetworkRuleSet property from JSO
9292

9393
### Example 5: Create a Storage account with Hierarchical Namespace enabled.
9494
```powershell
95-
PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Location "US West" -SkuName "Standard_GRS" -Kind StorageV2 -EnableHierarchicalNamespace $true
95+
PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "US West" -SkuName "Standard_GRS" -Kind StorageV2 -EnableHierarchicalNamespace $true
9696
```
9797

9898
This command creates a Storage account with Hierarchical Namespace enabled.
9999

100100
### Example 6: Create a Storage account with Azure Files AAD DS Authentication, and enable large file share.
101101
```powershell
102-
PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EnableAzureActiveDirectoryDomainServicesForFile $true -EnableLargeFileShare
102+
PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EnableAzureActiveDirectoryDomainServicesForFile $true -EnableLargeFileShare
103103
```
104104

105105
This command creates a Storage account with Azure Files AAD DS Authentication, and enable large file share.
106106

107107
### Example 7: Create a Storage account with enable Files Active Directory Domain Service Authentication and DefaultSharePermission.
108108
```
109-
PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EnableActiveDirectoryDomainServicesForFile $true `
109+
PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EnableActiveDirectoryDomainServicesForFile $true `
110110
-ActiveDirectoryDomainName "mydomain.com" `
111111
-ActiveDirectoryNetBiosDomainName "mydomain.com" `
112112
-ActiveDirectoryForestName "mydomain.com" `
@@ -122,9 +122,9 @@ This command creates a Storage account withenable Files Active Directory Domain
122122

123123
### Example 8: Create a Storage account with Queue and Table Service use account-scoped encryption key, and Require Infrastructure Encryption.
124124
```powershell
125-
PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EncryptionKeyTypeForTable Account -EncryptionKeyTypeForQueue Account -RequireInfrastructureEncryption
125+
PS C:\>New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EncryptionKeyTypeForTable Account -EncryptionKeyTypeForQueue Account -RequireInfrastructureEncryption
126126
127-
PS C:\>$account = get-AzStorageAccount -ResourceGroupName $rgname -StorageAccountName $accountName
127+
PS C:\>$account = Get-AzStorageAccount -ResourceGroupName $rgname -Name $accountName
128128
129129
PS C:\>$account.Encryption.Services.Queue
130130
@@ -147,7 +147,7 @@ Then get the Storage account properties, and view the encryption keytype of Queu
147147

148148
### Example 9: Create account MinimumTlsVersion and AllowBlobPublicAccess, and disable SharedKey Access
149149
```
150-
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -MinimumTlsVersion TLS1_1 -AllowBlobPublicAccess $false -AllowSharedKeyAccess $false
150+
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -MinimumTlsVersion TLS1_1 -AllowBlobPublicAccess $false -AllowSharedKeyAccess $false
151151
152152
PS C:\> $account.MinimumTlsVersion
153153
TLS1_1
@@ -163,7 +163,7 @@ The command create account with MinimumTlsVersion, AllowBlobPublicAccess, and di
163163

164164
### Example 10: Create a Storage account with RoutingPreference setting
165165
```powershell
166-
PS C:\>$account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -PublishMicrosoftEndpoint $true -PublishInternetEndpoint $true -RoutingChoice MicrosoftRouting
166+
PS C:\>$account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -PublishMicrosoftEndpoint $true -PublishInternetEndpoint $true -RoutingChoice MicrosoftRouting
167167
168168
PS C:\>$account.RoutingPreference
169169
@@ -189,7 +189,7 @@ This command creates a Storage account with RoutingPreference setting: PublishMi
189189

190190
### Example 11: Create a Storage account with EdgeZone and AllowCrossTenantReplication
191191
```powershell
192-
PS C:\>$account = New-AzStorageAccount -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -SkuName Premium_LRS -Location westus -EdgeZone "microsoftlosangeles1" -AllowCrossTenantReplication $false
192+
PS C:\>$account = New-AzStorageAccount -ResourceGroupName "myresourcegroup" -Name "mystorageaccount" -SkuName Premium_LRS -Location westus -EdgeZone "microsoftlosangeles1" -AllowCrossTenantReplication $false
193193
194194
PS C:\>$account.ExtendedLocation
195195
@@ -205,7 +205,7 @@ This command creates a Storage account with EdgeZone as "microsoftlosangeles1" a
205205

206206
### Example 12: Create a Storage account with KeyExpirationPeriod and SasExpirationPeriod
207207
```powershell
208-
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -SkuName Premium_LRS -Location eastus -KeyExpirationPeriodInDay 5 -SasExpirationPeriod "1.12:05:06"
208+
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "myresourcegroup" -Name "mystorageaccount" -SkuName Premium_LRS -Location eastus -KeyExpirationPeriodInDay 5 -SasExpirationPeriod "1.12:05:06"
209209
210210
PS C:\> $$account.KeyPolicy.KeyExpirationPeriodInDays
211211
5
@@ -251,7 +251,7 @@ This command first create a keyvault and a user assigned identity, then create a
251251

252252
### Example 13: Create account with EnableNfsV3
253253
```
254-
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -EnableNfsV3 $true -EnableHierarchicalNamespace $true -EnableHttpsTrafficOnly $false -NetworkRuleSet (@{bypass="Logging,Metrics";
254+
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -EnableNfsV3 $true -EnableHierarchicalNamespace $true -EnableHttpsTrafficOnly $false -NetworkRuleSet (@{bypass="Logging,Metrics";
255255
virtualNetworkRules=(@{VirtualNetworkResourceId="$vnet1";Action="allow"});
256256
defaultAction="deny"})
257257
PS C:\> $account.EnableNfsV3
@@ -262,7 +262,7 @@ The command create account with EnableNfsV3 as true, and then show the EnableNfs
262262

263263
### Example 14: Create account with disable PublicNetworkAccess
264264
```
265-
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -PublicNetworkAccess Disabled
265+
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -PublicNetworkAccess Disabled
266266
267267
PS C:\> $account.PublicNetworkAccess
268268
Disabled
@@ -272,7 +272,7 @@ The command creates account with disable PublicNetworkAccess of the account.
272272

273273
### Example 15: Create account with account level mmutability policy
274274
```
275-
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -EnableAccountLevelImmutability -ImmutabilityPeriod 1 -ImmutabilityPolicyState Unlocked
275+
PS C:\> $account = New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -SkuName Standard_LRS -Location centraluseuap -Kind StorageV2 -EnableAccountLevelImmutability -ImmutabilityPeriod 1 -ImmutabilityPolicyState Unlocked
276276
277277
PS C:\> $account.ImmutableStorageWithVersioning.Enabled
278278
True

src/Storage/Storage.Management/help/Remove-AzStorageAccount.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The **Remove-AzStorageAccount** cmdlet removes a Storage account from Azure.
2525

2626
### Example 1: Remove a Storage account
2727
```
28-
PS C:\>Remove-AzStorageAccount -ResourceGroupName "RG01" -AccountName "mystorageaccount"
28+
PS C:\>Remove-AzStorageAccount -ResourceGroupName "RG01" -Name "mystorageaccount"
2929
```
3030

3131
This command removes the specified Storage account.

src/Storage/Storage.Management/help/Remove-AzStorageAccountNetworkRule.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,42 +59,42 @@ The **Remove-AzStorageAccountNetworkRule** cmdlet removes IpRules or VirtualNetw
5959

6060
### Example 1: Remove several IpRules with IPAddressOrRange
6161
```
62-
PS C:\>Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -IPAddressOrRange "10.0.0.0/7,28.1.0.0/16"
62+
PS C:\>Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPAddressOrRange "10.0.0.0/7,28.1.0.0/16"
6363
```
6464

6565
This command remove several IpRules with IPAddressOrRange.
6666

6767
### Example 2: Remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON
6868
```
69-
PS C:\>Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -VirtualNetworkRules (@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"})
69+
PS C:\>Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkRules (@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"})
7070
```
7171

7272
This command remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON.
7373

7474
### Example 3: Remove first IpRule with pipeline
7575
```
76-
PS C:\>(Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount").IpRules[0] | Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount"
76+
PS C:\>(Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount").IpRules[0] | Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "myStorageAccount"
7777
```
7878

7979
This command remove first IpRule with pipeline.
8080

8181
### Example 4: Remove several VirtualNetworkRules with VirtualNetworkResourceID
8282
```
83-
PS C:\>Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -VirtualNetworkResourceId "/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1","/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2"
83+
PS C:\>Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkResourceId "/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1","/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2"
8484
```
8585

8686
This command remove several VirtualNetworkRules with VirtualNetworkResourceID.
8787

8888
### Example 5: Remove a resource access rule with TenantId and ResourceId.
8989
```
90-
PS C:\>Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -TenantId $tenantId -ResourceId $ResourceId
90+
PS C:\>Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -TenantId $tenantId -ResourceId $ResourceId
9191
```
9292

9393
This command removes a resource access rule with TenantId and ResourceId.
9494

9595
### Example 6: Remove the first 3 resource access rules from a storage account
9696
```
97-
PS C:\> (Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount").ResourceAccessRules | Select-Object -First 3 | Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount"
97+
PS C:\> (Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount").ResourceAccessRules | Select-Object -First 3 | Remove-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount"
9898
```
9999

100100
This command removes the first 3 resource access rules from a storage account.

src/Storage/Storage.Management/help/Set-AzCurrentStorageAccount.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The current Storage account is used as the default when you access Storage witho
3333

3434
### Example 1: Set the current Storage account
3535
```
36-
PS C:\>Set-AzCurrentStorageAccount -ResourceGroupName "RG01" -AccountName "mystorageaccount"
36+
PS C:\>Set-AzCurrentStorageAccount -ResourceGroupName "RG01" -Name "mystorageaccount"
3737
```
3838

3939
This command sets the default Storage account for the specified subscription.

0 commit comments

Comments
 (0)