Compartilhar via


Set-AzureRmPolicySetDefinition

Modifica uma definição de conjunto de políticas

Aviso

O módulo do PowerShell do AzureRM foi oficialmente preterido em 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.

Syntax

Set-AzureRmPolicySetDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmPolicySetDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   -ManagementGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmPolicySetDefinition
   -Name <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   -SubscriptionId <Guid>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmPolicySetDefinition
   -Id <String>
   [-DisplayName <String>]
   [-Description <String>]
   [-PolicyDefinition <String>]
   [-Metadata <String>]
   [-Parameter <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet Set-AzureRmPolicySetDefinition modifica uma definição de política.

Exemplos

Exemplo 1: Atualizar a descrição de uma definição de conjunto de políticas

PS C:\> $PolicySetDefinition = Get-AzureRmPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
PS C:\> Set-AzureRmPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

O primeiro comando obtém uma definição de conjunto de políticas usando o cmdlet Get-AzureRmPolicySetDefinition. O comando armazena esse objeto na variável $PolicySetDefinition. O segundo comando atualiza a descrição da definição do conjunto de políticas identificado pela propriedade ResourceId de $PolicySetDefinition.

Parâmetros

-ApiVersion

Quando definido, indica a versão da API do provedor de recursos a ser usada. Se não for especificada, a versão da API será determinada automaticamente como a mais recente disponível.

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

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

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

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure

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

-Description

A descrição para a definição do conjunto de políticas.

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

-DisplayName

O nome para exibição da definição do conjunto de políticas.

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

-Id

A ID de definição de política totalmente qualificada, incluindo a assinatura. por exemplo, /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}

Type:String
Aliases:ResourceId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ManagementGroupName

O nome do grupo de gerenciamento da definição do conjunto de políticas a ser atualizado.

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

-Metadata

Os metadados da definição atualizada do conjunto de políticas. Isso pode ser um caminho para um nome de arquivo que contém os metadados ou os metadados como uma cadeia de caracteres.

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

-Name

O nome da definição do conjunto de políticas.

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

-Parameter

A declaração de parâmetros da definição atualizada do conjunto de políticas. Isso pode ser um caminho para um nome de arquivo ou uri que contém a declaração de parâmetros ou a declaração de parâmetros como uma cadeia de caracteres.

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

-PolicyDefinition

A definição do conjunto de políticas. Isso pode ser um caminho para um nome de arquivo que contém as definições de diretiva ou a definição do conjunto de políticas como cadeia de caracteres.

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

-Pre

Quando definido, indica que o cmdlet deve usar versões de API de pré-lançamento ao determinar automaticamente qual versão usar.

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

-SubscriptionId

A ID de assinatura da definição do conjunto de políticas a ser atualizada.

Type:Nullable<T>[Guid]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

Entradas

String

Nullable<T>[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Saídas

PSObject