Edit

Share via

Set-AzMediaServiceKey

  • Reference
Module:
Az.Media

Regenerates a key used for accessing the REST endpoint associated with the media service.

Syntax

Set-AzMediaServiceKey
   [-ResourceGroupName] <String>
   [-AccountName] <String>
   [-KeyType] <KeyType>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzMediaServiceKey cmdlet regenerates a key used for accessing the Representational State Transfer (REST) endpoint associated with the media service.

Examples

Example 1: Regenerate the primary key used for accessing the Media Service

Set-AzMediaServiceKey -ResourceGroupName "ResourceGroup004" -AccountName "MediaService001" -KeyType Primary

This command regenerates the primary key for the media service named MediaService001 that belongs to the resource group named ResourceGroup004.

Example 2: Regenerates the secondary key used for accessing the Media Service

Set-AzMediaServiceKey -ResourceGroupName "Resourcegroup123" -AccountName "MediaService002" -KeyType Secondary

This command regenerates the secondary key for the media service named MediaService002 that belongs to the resource group named Resourcegroup123.

Parameters

-AccountName

Specifies the name of the media service that this cmdlet regenerates.

Type:String
Aliases:Name, ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyType

Specifies the key type of the media service. The acceptable values for this parameter are: Primary or Secondary.

Type:Microsoft.Azure.Management.Media.Models.KeyType
Accepted values:Primary, Secondary
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group that contains the media service.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSServiceKey