Skip to content

Commit 077c409

Browse files
markcowlmarkcowl
authored
Merge pull request Azure#2707 from fredericky/ams-help
Add examples of the AMS cmdlets.
2 parents 75cc2d6 + 2ca8e8f commit 077c409

File tree

2 files changed

+462
-9
lines changed

2 files changed

+462
-9
lines changed

‎src/ResourceManager/Media/Commands.Media/Microsoft.Azure.Commands.Media.dll-help.Help.pshproj

Lines changed: 156 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,20 @@
8383
<DefaultValue />
8484
</ParameterDescription>
8585
</Parameters>
86-
<Examples />
86+
<Examples>
87+
<Example>
88+
<Name>Example 1: Get all media services in a resource group</Name>
89+
<Cmd>PS C:\&gt;Get-AzureRmMediaService -ResourceGroupName "resourcegroup1"</Cmd>
90+
<Description>This command gets properties for all media services in the resource group named resourcegroup1.</Description>
91+
<Output />
92+
</Example>
93+
<Example>
94+
<Name>Example 2: Get media service properties</Name>
95+
<Cmd>PS C:\&gt;Get-AzureRmMediaService -ResourceGroupName "resourcegroup1" -AccountName "mediaservice1"</Cmd>
96+
<Description>This command gets the properties of the media service named mediaservice1 in the resource group named resourcegroup1.</Description>
97+
<Output />
98+
</Example>
99+
</Examples>
87100
<RelatedLinks />
88101
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
89102
<Publish>false</Publish>
@@ -160,7 +173,14 @@
160173
<DefaultValue />
161174
</ParameterDescription>
162175
</Parameters>
163-
<Examples />
176+
<Examples>
177+
<Example>
178+
<Name>Example 1: Get the key information for accessing the media service.</Name>
179+
<Cmd>PS C:\&gt;Get-AzureRmMediaServiceKeys -ResourceGroupName "resourcegroup1" -AccountName "mediaservice1"</Cmd>
180+
<Description>This command get the key information for accessing the media service named mediaservice1 in the resource group named resourcegroup1.</Description>
181+
<Output />
182+
</Example>
183+
</Examples>
164184
<RelatedLinks />
165185
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
166186
<Publish>false</Publish>
@@ -225,7 +245,14 @@
225245
<DefaultValue />
226246
</ParameterDescription>
227247
</Parameters>
228-
<Examples />
248+
<Examples>
249+
<Example>
250+
<Name>Example 1: Checks whether a Media Service name is available.</Name>
251+
<Cmd>PS C:\&gt;Get-AzureRmMediaServiceNameAvailability -AccountName "mediaservice1"</Cmd>
252+
<Description>This command checks if the name mediaservice1 is available.</Description>
253+
<Output />
254+
</Example>
255+
</Examples>
229256
<RelatedLinks />
230257
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
231258
<Publish>false</Publish>
@@ -374,7 +401,72 @@
374401
<DefaultValue />
375402
</ParameterDescription>
376403
</Parameters>
377-
<Examples />
404+
<Examples>
405+
<Example>
406+
<Name>Example1: Create a media service with the primary storage account only</Name>
407+
<Cmd>PS C:\&gt;# Variables
408+
## Global
409+
$ResourceGroupName = "resourcegroup1"
410+
$Location = "East US"
411+
412+
## Storage
413+
$StorageName = "storage1"
414+
$StorageType = "Standard_GRS"
415+
416+
## Media Service
417+
$Tags = @{"tag1" = "value1"; "tag2" = "value2"}
418+
$MediaServiceName = "mediaservice1"
419+
420+
# Resource Group
421+
New-AzureRmResourceGroup -Name $ResourceGroupName -Location $Location
422+
423+
# Storage
424+
$StorageAccount = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName -Location $Location -Type $StorageType
425+
426+
# Media Service
427+
New-AzureRmMediaService -ResourceGroupName $ResourceGroupName -AccountName $MediaServiceName -Location $Location -StorageAccountId $StorageAccount.Id -Tags $Tags
428+
</Cmd>
429+
<Description>This example shows how to create a media service with specifying primary storage account only. This script uses several other cmdlets.</Description>
430+
<Output />
431+
</Example>
432+
<Example>
433+
<Name>Example 2: Create a media service with multiple storage accounts</Name>
434+
<Cmd>PS C:\&gt;# Variables
435+
436+
## Global
437+
$ResourceGroupName = "resourcegroup1"
438+
$Location = "East US"
439+
440+
## Storage
441+
$StorageName1 = "storage1"
442+
$StorageName2 = "storage2"
443+
$StorageType = "Standard_GRS"
444+
445+
## Media Service
446+
$Tags = @{"tag1" = "value1"; "tag2" = "value2"}
447+
$MediaServiceName = "mediaservice1"
448+
449+
# Resource Group
450+
New-AzureRmResourceGroup -Name $ResourceGroupName -Location $Location
451+
452+
# Storage
453+
$StorageAccount1 = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName1 -Location $Location -Type $StorageType
454+
$StorageAccount2 = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name $StorageName2 -Location $Location -Type $StorageType
455+
456+
# Media Service
457+
458+
## Setup the storage configuration object.
459+
$PrimaryStorageAccount = New-AzureRmMediaServiceStorageConfig -StorageAccountId $StorageAccount1.Id -IsPrimary
460+
$SecondaryStorageAccount = New-AzureRmMediaServiceStorageConfig -StorageAccountId $StorageAccount2.Id
461+
$StorageAccounts = @($PrimaryStorageAccount, $SecondaryStorageAccount)
462+
463+
## Create a media service.
464+
New-AzureRmMediaService -ResourceGroupName $ResourceGroupName -AccountName $MediaServiceName -Location $Location -StorageAccounts $StorageAccounts -Tags $Tags
465+
</Cmd>
466+
<Description>This command shows how to create a media service with multiple storage accounts. This script uses several other cmdlets.</Description>
467+
<Output />
468+
</Example>
469+
</Examples>
378470
<RelatedLinks />
379471
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
380472
<Publish>false</Publish>
@@ -484,7 +576,14 @@
484576
<DefaultValue />
485577
</ParameterDescription>
486578
</Parameters>
487-
<Examples />
579+
<Examples>
580+
<Example>
581+
<Name>Example 1: Remove a media service</Name>
582+
<Cmd>PS C:\&gt;Remove-AzureRmMediaService -ResourceGroupName "resourcegroup1" -AccountName "mediaservice1"</Cmd>
583+
<Description>This command removes the media service named mediaservice1 in the resource group resourcegroup1.</Description>
584+
<Output />
585+
</Example>
586+
</Examples>
488587
<RelatedLinks />
489588
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
490589
<Publish>false</Publish>
@@ -605,7 +704,15 @@
605704
<DefaultValue />
606705
</ParameterDescription>
607706
</Parameters>
608-
<Examples />
707+
<Examples>
708+
<Example>
709+
<Name>Example 1: Set a media service.</Name>
710+
<Cmd>PS C:\&gt;$Tags = @{"tag1" = "value1"; "tag2" = "value2"}
711+
Set-AzureRmMediaService -ResourceGroupName "resourcegroup1" -AccountName "mediaservice1" -Tags $Tags -StorageAccounts $StorageAccounts</Cmd>
712+
<Description>This command updates the media service named mediaservice1 in the resource group named resourcegroup1 with tags object stored in $Tags variable and an array of storage configuration objects stored in $StorageAccounts variable. For how to build an array of storage configuration objects, please see the Example 2 of New-AzureRmMediaService cmdlet.</Description>
713+
<Output />
714+
</Example>
715+
</Examples>
609716
<RelatedLinks />
610717
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
611718
<Publish>false</Publish>
@@ -715,7 +822,20 @@
715822
<DefaultValue />
716823
</ParameterDescription>
717824
</Parameters>
718-
<Examples />
825+
<Examples>
826+
<Example>
827+
<Name>Example 1: Regenerates the primary key used for accessing the Media Service.</Name>
828+
<Cmd>PS C:\&gt;Set-AzureRmMediaServiceKey -ResourceGroupName "resourcegroup1" -AccountName "mediaservice1" -KeyType Primary</Cmd>
829+
<Description>This command regenerates the primary key for the media service named mediaservice1 in the resource group named resourcegroup1.</Description>
830+
<Output />
831+
</Example>
832+
<Example>
833+
<Name>Exmaple 2: Regenerates the secondary key used for accessing the Media Service.</Name>
834+
<Cmd>PS C:\&gt;Set-AzureRmMediaServiceKey -ResourceGroupName "resourcegroup1" -AccountName "mediaservice1" -KeyType Secondary</Cmd>
835+
<Description>This command regenerates the secondary key for the media service named mediaservice1 in the resource group named resourcegroup1.</Description>
836+
<Output />
837+
</Example>
838+
</Examples>
719839
<RelatedLinks />
720840
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
721841
<Publish>false</Publish>
@@ -829,7 +949,21 @@
829949
<DefaultValue />
830950
</ParameterDescription>
831951
</Parameters>
832-
<Examples />
952+
<Examples>
953+
<Example>
954+
<Name>Example 1: Synchronizes storage account keys for a storage account associated with the Media Service.</Name>
955+
<Cmd>PS C:\&gt;# Variables
956+
$ResoureceGroupName = "resourcegroup1"
957+
958+
# Gets a storage account associated with the media service.
959+
$StorageAccount = Get-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name "storage1"
960+
961+
# Synchronizes the storage account keys.
962+
Sync-AzureRmMediaServiceStorageKeys -ResourceGroupName $ResourceGroupName -AccoutName "mediaservice1" -StorageAccoutId $StorageAccount.Id</Cmd>
963+
<Description>This command synchronizes the keys of storage account named storage1 associated with the media service named mediaservice1 in the resource group resourcegroup1.</Description>
964+
<Output />
965+
</Example>
966+
</Examples>
833967
<RelatedLinks />
834968
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
835969
<Publish>false</Publish>
@@ -924,7 +1058,20 @@
9241058
<DefaultValue />
9251059
</ParameterDescription>
9261060
</Parameters>
927-
<Examples />
1061+
<Examples>
1062+
<Example>
1063+
<Name>Example 1: Create a storage account configuration for the media service Cmdlets.</Name>
1064+
<Cmd>PS C:\&gt;# Create a storage account.
1065+
$StorageAccount = New-AzureRmStorageAccount -ResourceGroupName $ResourceGroupName -Name "storage1" -Location "East US" -Type "Standard_GRS"
1066+
1067+
# Create a storage configuration object as the primary storage account associated with the media service.
1068+
New-AzureRmMediaServiceStorageConfig -StorageAccountId $StorageAccount.Id -IsPrimary
1069+
1070+
</Cmd>
1071+
<Description>This command creates a storage configuration object by using storage account named storage1 and specifying it as the primary.</Description>
1072+
<Output />
1073+
</Example>
1074+
</Examples>
9281075
<RelatedLinks />
9291076
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
9301077
<Publish>false</Publish>

0 commit comments

Comments
 (0)