Skip to content

Latest commit

 

History

History
152 lines (113 loc) · 3.9 KB

Set-AzureRmMediaServiceKey.md

File metadata and controls

152 lines (113 loc) · 3.9 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.Commands.Media.dll-Help.xml
AzureRM.Media
D28EB28D-DBC6-48D5-AB0A-C56F56CD0104
2.0.0

Set-AzureRmMediaServiceKey

SYNOPSIS

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

SYNTAX

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

DESCRIPTION

The Set-AzureRmMediaServiceKey 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

PS C:\>Set-AzureRmMediaServiceKey -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

PS C:\>Set-AzureRmMediaServiceKey -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: System.String
Parameter Sets: (All)
Aliases: Name, ResourceName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:
Accepted values: Primary, Secondary

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.Media.Models.PSServiceKey

NOTES

RELATED LINKS

Get-AzureRmMediaServiceKeys