Dela via


Set-AzPolicySetDefinition

Ändrar en principuppsättningsdefinition

Syntax

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

Description

Cmdleten Set-AzPolicySetDefinition ändrar en principdefinition.

Exempel

Exempel 1: Uppdatera beskrivningen av en principuppsättningsdefinition

$PolicySetDefinition = Get-AzPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
Set-AzPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

Det första kommandot hämtar en principuppsättningsdefinition med cmdleten Get-AzPolicySetDefinition. Kommandot lagrar objektet i variabeln $PolicySetDefinition. Det andra kommandot uppdaterar beskrivningen av den principuppsättningsdefinition som identifieras av egenskapen ResourceId för $PolicySetDefinition.

Exempel 2: Uppdatera metadata för en principuppsättningsdefinition

Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

Name                  : VMPolicySetDefinition
ResourceId            : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policySetDefinitions/VMPolicySetDefinition
ResourceName          : VMPolicySetDefinition
ResourceType          : Microsoft.Authorization/policySetDefinitions
SubscriptionId        : 11111111-1111-1111-1111-111111111111
Properties            : @{displayName=VMPolicySetDefinition; policyType=Custom; metadata=; parameters=; policyDefinitions=System.Object[]}
PolicySetDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policySetDefinitions/VMPolicySetDefinition

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

Exempel 3: Uppdatera grupperna i en principuppsättningsdefinition

Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition '[{ "name": "group1", "displayName": "Virtual Machine Security" }, { "name": "group2" }]'

Det här kommandot uppdaterar grupperna i en principuppsättningsdefinition med namnet VMPolicySetDefinition.

Exempel 4: Uppdatera grupperna i en principuppsättningsdefinition med hjälp av en hash-tabell

$groupsJson = ConvertTo-Json @{ name = "group1"; displayName = "Virtual Machine Security" }, @{ name = "group2" }
Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson

Det här kommandot uppdaterar grupperna i en principuppsättningsdefinition med namnet VMPolicySetDefinition med hjälp av en hash-tabell för att konstruera grupperna.

Parametrar

-ApiVersion

När värdet anges anger du vilken version av resursprovider-API:et som ska användas. Om den inte anges bestäms API-versionen automatiskt som den senaste tillgängliga.

Typ:String
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

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure

Typ:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
standardvärde:None
Obligatorisk:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Beskrivningen för principuppsättningsdefinitionen.

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

-DisplayName

Visningsnamnet för principuppsättningsdefinitionen.

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

-GroupDefinition

Principdefinitionsgrupperna för den uppdaterade principuppsättningsdefinitionen. Detta kan antingen vara en sökväg till en fil som innehåller grupperna eller grupperna som en JSON-sträng.

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

-Id

Det fullständigt kvalificerade principdefinitions-ID:t, inklusive prenumerationen. t.ex. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}

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

-InputObject

Definitionsobjektet för principuppsättningen som ska uppdateras som utdata från en annan cmdlet.

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

-ManagementGroupName

Namnet på hanteringsgruppen för den principuppsättningsdefinition som ska uppdateras.

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

-Metadata

Metadata för den uppdaterade principuppsättningsdefinitionen. Detta kan antingen vara en sökväg till ett filnamn som innehåller metadata eller metadata som en JSON-sträng.

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

-Name

Definitionsnamnet för principuppsättningen.

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

-Parameter

Parameterdeklarationen för den uppdaterade principuppsättningsdefinitionen. Detta kan antingen vara en sökväg till ett filnamn eller en URI som innehåller parameterdeklarationen eller parameterdeklarationen som en JSON-sträng.

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

-PolicyDefinition

Principdefinitionerna. Det kan antingen vara en sökväg till ett filnamn som innehåller principdefinitionerna eller principdefinitionerna som en JSON-sträng.

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

-Pre

När den anges anger att cmdleten ska använda förhandsversioner av API-versioner när du automatiskt avgör vilken version som ska användas.

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

-SubscriptionId

Prenumerations-ID för den principuppsättningsdefinition som ska uppdateras.

Typ:Nullable<T>[Guid]
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

String

Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Utdata

PSObject