Dela via


Update-AzPolicyDefinition

Den här åtgärden uppdaterar en befintlig principdefinition i den angivna prenumerationen eller hanteringsgruppen med det angivna namnet.

Syntax

Update-AzPolicyDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicyDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicyDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicyDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicyDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      -InputObject <IPolicyDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Den här åtgärden uppdaterar en befintlig principdefinition i den angivna prenumerationen eller hanteringsgruppen med det angivna namnet.

Exempel

Exempel 1: Uppdatera beskrivningen av en principdefinition

$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition'
Update-AzPolicyDefinition -Id $PolicyDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

Det första kommandot hämtar en principdefinition med namnet VMPolicyDefinition med hjälp av cmdleten Get-AzPolicyDefinition. Kommandot lagrar objektet i variabeln $PolicyDefinition. Det andra kommandot uppdaterar beskrivningen av principdefinitionen som identifieras av egenskapen ResourceId för $PolicyDefinition.

Exempel 2: Uppdatera läget för en principdefinition

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

Det här kommandot uppdaterar principdefinitionen med namnet VMPolicyDefinition med hjälp av cmdleten Update-AzPolicyDefinition för att ange dess lägesegenskap till "Alla".

Exempel 3: Uppdatera metadata för en principdefinition

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}'

Det här kommandot uppdaterar metadata för en principdefinition med namnet VMPolicyDefinition för att ange att dess kategori är "Virtuell dator".

Exempel 3: [Backcompat] Uppdatera läget för en principdefinition

Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

Det här kommandot uppdaterar principdefinitionen med namnet VMPolicyDefinition med hjälp av aliaset Set-AzPolicyDefinition för cmdleten Update-AzPolicyDefinition för att ange dess lägesegenskap till "Alla".

Parametrar

-BackwardCompatible

Gör att cmdleten returnerar artefakter med äldre format som placerar principspecifika egenskaper i ett egenskapspåseobjekt.

Typ:SwitchParameter
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Aliases:cf
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Parametern DefaultProfile fungerar inte. Använd parametern SubscriptionId när den är tillgänglig om du kör cmdleten mot en annan prenumeration.

Typ:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Beskrivningen av principdefinitionen.

Typ:String
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplayName

Principdefinitionens visningsnamn.

Typ:String
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

Resurs-ID för principdefinitionen som ska uppdateras.

Typ:String
Aliases:ResourceId
Position:Named
standardvärde:None
Obligatorisk:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Typ:IPolicyDefinition
Position:Named
standardvärde:None
Obligatorisk:True
Accept pipeline input:True
Accept wildcard characters:False

-ManagementGroupName

ID för hanteringsgruppen.

Typ:String
Position:Named
standardvärde:None
Obligatorisk:True
Accept pipeline input:True
Accept wildcard characters:False

-Metadata

Metadata för principdefinition. Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.

Typ:String
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:True
Accept wildcard characters:False

-Mode

Principdefinitionsläget. Några exempel är Alla, Indexerade, Microsoft.KeyVault.Data.

Typ:String
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Namnet på den principdefinition som ska uppdateras.

Typ:String
Aliases:PolicyDefinitionName
Position:Named
standardvärde:None
Obligatorisk:True
Accept pipeline input:True
Accept wildcard characters:False

-Parameter

Parameterdefinitionerna för parametrar som används i principregeln. Nycklarna är parameternamnen.

Typ:String
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:False
Accept wildcard characters:False

-Policy

Principregeln.

Typ:String
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

ID för målprenumerationen.

Typ:String
Position:Named
standardvärde:None
Obligatorisk:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Typ:SwitchParameter
Aliases:wi
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:False
Accept wildcard characters:False

Indata

IPolicyDefinition

String

Utdata

IPolicyDefinition

Kommentarer

ALIAS

Set-AzPolicyDefinition