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 Set-AzPolicyDefinition aliaset 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 |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Typ: | SwitchParameter |
Alias: | cf |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | 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 |
Alias: | AzureRMContext, AzureCredential |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-Description
Beskrivningen av principdefinitionen.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-DisplayName
Principdefinitionens visningsnamn.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Id
Resurs-ID för principdefinitionen som ska uppdateras.
Typ: | String |
Alias: | ResourceId |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-InputObject
Typ: | IPolicyDefinition |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-ManagementGroupName
ID för hanteringsgruppen.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | 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 |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Mode
Principdefinitionsläget. Några exempel är Alla, Indexerade, Microsoft.KeyVault.Data.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Name
Namnet på den principdefinition som ska uppdateras.
Typ: | String |
Alias: | PolicyDefinitionName |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Parameter
Parameterdefinitionerna för parametrar som används i principregeln. Nycklarna är parameternamnen.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-Policy
Principregeln.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-SubscriptionId
ID för målprenumerationen.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-WhatIf
Visar vad som skulle hända om cmdleten körs. Cmdleten körs inte.
Typ: | SwitchParameter |
Alias: | wi |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
Indata
Utdata
Kommentarer
ALIAS
Set-AzPolicyDefinition
Azure PowerShell