Update-AzPolicyEnrollment

Den här åtgärden uppdaterar en principregistrering med de nyligen angivna egenskaperna.

Syntax

UpdateByNameAndScope (Standard)

Update-AzPolicyEnrollment
    -Name <String>
    -Scope <String>
    [-Description <String>]
    [-DisplayName <String>]
    [-AssignmentScopeValidation <String>]
    [-ResourceSelector <IResourceSelector[]>]
    [-PolicyDefinitionReferenceId <String[]>]
    [-Metadata <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

UpdateByInputObject

Update-AzPolicyEnrollment
    -InputObject <IPolicyEnrollment>
    [-Description <String>]
    [-DisplayName <String>]
    [-AssignmentScopeValidation <String>]
    [-ResourceSelector <IResourceSelector[]>]
    [-PolicyDefinitionReferenceId <String[]>]
    [-Metadata <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

UpdateById

Update-AzPolicyEnrollment
    -Id <String>
    [-Description <String>]
    [-DisplayName <String>]
    [-AssignmentScopeValidation <String>]
    [-ResourceSelector <IResourceSelector[]>]
    [-PolicyDefinitionReferenceId <String[]>]
    [-Metadata <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Cmdleten Update-AzPolicyEnrollment uppdaterar en principregistrering med de nyligen angivna egenskaperna.

Alla egenskaper som inte tillhandahålls bevaras från den befintliga registreringen.

Exempel

Exempel 1: Uppdatera visningsnamnet

$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
$PolicyEnrollment = Get-AzPolicyEnrollment -Name 'PolicyEnrollment07' -Scope $ResourceGroup.ResourceId
Update-AzPolicyEnrollment -Id $PolicyEnrollment.Id -DisplayName 'Enrollment for VM location policy'

Det första kommandot hämtar en resursgrupp med namnet ResourceGroup11 med hjälp av cmdleten Get-AzResourceGroup. Kommandot lagrar objektet i variabeln $ResourceGroup. Det andra kommandot hämtar principregistreringen med namnet PolicyEnrollment07 med hjälp av cmdleten Get-AzPolicyEnrollment. Kommandot lagrar objektet i variabeln $PolicyEnrollment. Det sista kommandot uppdaterar visningsnamnet på principregistreringen som identifieras av ID-egenskapen för $PolicyEnrollment.

Exempel 2: Uppdatera via pipeline

$PolicyEnrollment = Get-AzPolicyEnrollment -Name 'PolicyEnrollment07' -Scope "/subscriptions/$((Get-AzContext).Subscription.Id)"
$PolicyEnrollment.DisplayName = 'Updated VM Enrollment'
$PolicyEnrollment | Update-AzPolicyEnrollment

Det första kommandot hämtar principregistreringen med namnet PolicyEnrollment07 med hjälp av cmdleten Get-AzPolicyEnrollment och lagrar den i variabeln $PolicyEnrollment. Det andra kommandot anger ett nytt visningsnamn för objektet $PolicyEnrollment. Det sista kommandot skickar det ändrade objektet till Update-AzPolicyEnrollment för att spara ändringen.

Exempel 3: Uppdatera resursväljaren

$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
$ResourceSelector = @{Name = "MyLocationSelector"; Selector = @(@{Kind = "resourceLocation"; NotIn = @("eastus", "eastus2")})}
Update-AzPolicyEnrollment -Name 'VirtualMachinePolicyEnrollment' -Scope $ResourceGroup.ResourceId -ResourceSelector $ResourceSelector

Det första kommandot hämtar en resursgrupp med namnet ResourceGroup11 med hjälp av cmdleten Get-AzResourceGroup. Det andra kommandot skapar ett resursväljareobjekt som begränsar registreringen till resurser på andra platser än USA, östra eller USA, östra 2 och lagrar det i variabeln $ResourceSelector. Det sista kommandot uppdaterar principregistreringen med namnet VirtualMachinePolicyEnrollment med resursväljaren som anges av $ResourceSelector.

Parametrar

-AssignmentScopeValidation

Alternativet om man ska validera registreringen ligger på eller inom tilldelningsområdet.

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

-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 försäkringsanmälan.

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

Visningsnamnet på försäkringsanmälan.

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

ID:t för principregistreringen som ska uppdateras. Använd formatet {scope}/providers/Microsoft. Authorization/policyEnrollments/{policyEnrollmentName}'.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:ResourceId

Parameteruppsättningar

UpdateById
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

-InputObject

Det principregistreringsobjekt som ska uppdateras.

Parameteregenskaper

Typ:IPolicyEnrollment
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateByInputObject
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Metadata

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

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å försäkringsanmälan.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:PolicyEnrollmentName

Parameteruppsättningar

UpdateByNameAndScope
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

-PolicyDefinitionReferenceId

När den associerade principtilldelningen är för en principuppsättning (initiativ) kan detta användas för att ange principdefinitionens referens-ID:er för principdefinitioner i den principuppsättning som ska registreras till. Dessa ID:n motsvarar en delmängd av policyDefinitions[*].policyDefinitionReferenceId i policymängdens definition. När den anges och inte är tom, kommer endast de refererade policydefinitionerna att registreras. Annars registreras hela principuppsättningen till.

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

-ResourceSelector

Listan över resursväljare för att filtrera principer efter resursegenskaper.

Parameteregenskaper

Typ:

IResourceSelector[]

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

-Scope

Omfånget för principregistreringen. Giltiga omfång är: hanteringsgrupp (format: '/providers/Microsoft. Management/managementGroups/{managementGroup}'), prenumeration (format: '/subscriptions/{subscriptionId}'), resursgrupp (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'), eller resurs (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}')

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

UpdateByNameAndScope
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

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.

Indata

IPolicyEnrollment

IResourceSelector

String

String

Utdata

IPolicyEnrollment