Set-AzPolicyDefinition
Ändrar en principdefinition.
Syntax
Set-AzPolicyDefinition
-Name <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzPolicyDefinition
-Name <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
-ManagementGroupName <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzPolicyDefinition
-Name <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
-SubscriptionId <Guid>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzPolicyDefinition
-Id <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzPolicyDefinition
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
-InputObject <PsPolicyDefinition>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Cmdleten Set-AzPolicyDefinition ändrar en principdefinition.
Exempel
Exempel 1: Uppdatera beskrivningen av en principdefinition
$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition'
Set-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
Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'
Det här kommandot uppdaterar principdefinitionen med namnet VMPolicyDefinition med hjälp av cmdleten Set-AzPolicyDefinition för att ange dess lägesegenskap till "Alla".
Exempel 3: Uppdatera metadata för en principdefinition
Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}'
Name : VMPolicyDefinition
ResourceId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition
ResourceName : VMPolicyDefinition
ResourceType : Microsoft.Authorization/policyDefinitions
SubscriptionId : 11111111-1111-1111-1111-111111111111
Properties : @{displayName=VMPolicyDefinition; policyType=Custom; mode=All; metadata=; policyRule=}
PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition
Det här kommandot uppdaterar metadata för en principdefinition med namnet VMPolicyDefinition för att ange att dess kategori är "Virtuell dator".
Parametrar
-ApiVersion
Anger vilken version av resursprovider-API:et som ska användas. Om du inte anger någon version använder den här cmdleten den senaste tillgängliga versionen.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-DefaultProfile
Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure
Typ: | IAzureContextContainer |
Alias: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-Description
Anger en ny beskrivning av principdefinitionen.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-DisplayName
Anger ett nytt visningsnamn för principdefinitionen.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Id
Anger det fullständigt kvalificerade resurs-ID:t för principdefinitionen som den här cmdleten ändrar.
Typ: | String |
Alias: | ResourceId |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-InputObject
Principdefinitionsobjektet som skulle uppdateras som utdata från en annan cmdlet.
Typ: | PsPolicyDefinition |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-ManagementGroupName
Namnet på hanteringsgruppen för principdefinitionen som ska uppdateras.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Metadata
Metadata för principdefinition. Detta kan antingen vara en sökväg till ett filnamn som innehåller metadata eller metadata som sträng.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Mode
Läget för den nya principdefinitionen.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Name
Anger namnet på den principdefinition som den här cmdleten ändrar.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Parameter
Parameterdeklarationen för principdefinition. Detta kan antingen vara en sökväg till ett filnamn eller en URI som innehåller parameterdeklarationen eller parameterdeklarationen som sträng.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Policy
Anger ny principregel för principdefinitionen. Du kan ange sökvägen till en .json fil eller en sträng som innehåller principen i JSON-format (JavaScript Object Notation).
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
-Pre
Anger att den här cmdleten tar hänsyn till förhandsversioner av API:et när den automatiskt avgör vilken version som ska användas.
Typ: | SwitchParameter |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-SubscriptionId
Prenumerations-ID för principdefinitionen som ska uppdateras.
Typ: | Nullable<T>[Guid] |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | True |
Godkänn jokertecken: | False |
Indata
Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]