Update-AzPolicyDefinition
Den här åtgärden uppdaterar en befintlig principdefinition i den angivna prenumerationen eller hanteringsgruppen med det angivna namnet.
Syntax
Name (Standard)
Update-AzPolicyDefinition
-Name <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-Version <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SubscriptionId
Update-AzPolicyDefinition
-Name <String>
-SubscriptionId <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-Version <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ManagementGroupName
Update-AzPolicyDefinition
-Name <String>
-ManagementGroupName <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-Version <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Id
Update-AzPolicyDefinition
-Id <String>
[-DisplayName <String>]
[-Description <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzPolicyDefinition
-InputObject <IPolicyDefinition>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-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.Id -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 ID-egenskapen 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".
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 4: Uppdatera en principdefinition för att lägga till en äldre version med hjälp av en principfil
Update-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Version '1.1.0'
Det här kommandot uppdaterar den befintliga principdefinitionen med namnet LocationDefinition genom att lägga till version 1.1.0 som innehåller principregeln som anges i C:\LocationPolicy.jspå.
Parametrar
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Parameteregenskaper
Typ: SwitchParameter
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: jfr
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: 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.
Parameteregenskaper
Typ: PSObject
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: AzureRMContext, AzureCredential
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-Description
Beskrivningen av principdefinitionen.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-DisplayName
Principdefinitionens visningsnamn.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-EndpointSettingDetail
Information om slutpunkten.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-EndpointSettingKind
Typ av slutpunkt.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-ExternalEvaluationEnforcementSettingMissingTokenAction
Vad du ska göra när du utvärderar en tvingande princip som kräver en extern utvärdering och token saknas.
Möjliga värden är Granskning och Neka och språkuttryck stöds.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-ExternalEvaluationEnforcementSettingResultLifespan
Livslängden för slutpunktsanropsresultatet varefter det inte längre är giltigt.
Värdet förväntas följa iso 8601-varaktighetsformatet och språkuttryck stöds.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-ExternalEvaluationEnforcementSettingRoleDefinitionId
En matris med rolldefinitions-ID:t som tilldelningens MSI behöver för att anropa slutpunkten.
Parameteregenskaper
Typ: String [ ]
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-Id
Resurs-ID för principdefinitionen som ska uppdateras.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: ResourceId
Parameteruppsättningar
Id
Position: Named Obligatorisk: True Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
Den här åtgärden uppdaterar en befintlig principdefinition i den angivna prenumerationen eller hanteringsgruppen med det angivna namnet.
InputObject
Position: Named Obligatorisk: True Värde från pipeline: True Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-ManagementGroupName
ID för hanteringsgruppen.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
ManagementGroupName
Position: Named Obligatorisk: True Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
Metadata för principdefinition.
Metadata är ett öppet slutobjekt och är vanligtvis en samling nyckelvärdepar.
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-Mode
Principdefinitionsläget.
Några exempel är Alla, Indexerade, Microsoft.KeyVault.Data.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-Name
Namnet på den principdefinition som ska uppdateras.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: PolicyDefinitionName
Parameteruppsättningar
Name
Position: Named Obligatorisk: True Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
SubscriptionId
Position: Named Obligatorisk: True Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
ManagementGroupName
Position: Named Obligatorisk: True Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-Parameter
Parameterdefinitionerna för parametrar som används i principregeln.
Nycklarna är parameternamnen.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
-Policy
Principregeln.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
Name
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
SubscriptionId
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
ManagementGroupName
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
InputObject
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-SubscriptionId
ID för målprenumerationen.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False
Parameteruppsättningar
SubscriptionId
Position: Named Obligatorisk: True Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-Version
Principdefinitionsversionen i #.#.#-format.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: PolicyDefinitionVersion
Parameteruppsättningar
Name
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
SubscriptionId
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
ManagementGroupName
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: True Värde från återstående argument: False
-WhatIf
Visar vad som skulle hända om kommandot körs.
Cmdleten körs inte.
Parameteregenskaper
Typ: SwitchParameter
Standardvärde: None Stöder jokertecken: False DontShow: False Alias: Wi
Parameteruppsättningar
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter egenskapsnamn: False Värde från återstående argument: False
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters .
Utdata
Kommentarer
ALIAS
Set-AzPolicyDefinition
