Update-AzPolicyEnrollment

Cette opération met à jour une inscription de stratégie avec les propriétés nouvellement fournies.

Syntaxe

UpdateByNameAndScope (Par défaut)

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

L’applet de commande Update-AzPolicyEnrollment met à jour une inscription de stratégie avec les propriétés nouvellement fournies.

Toutes les propriétés non fournies sont conservées de l’inscription existante.

Exemples

Exemple 1 : mise à jour du nom d’affichage

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

La première commande obtient un groupe de ressources nommé ResourceGroup11 à l’aide de l’applet de commande Get-AzResourceGroup. La commande stocke cet objet dans la variable $ResourceGroup. La deuxième commande obtient l’inscription de stratégie nommée PolicyEnrollment07 à l’aide de l’applet de commande Get-AzPolicyEnrollment. La commande stocke cet objet dans la variable $PolicyEnrollment. La commande finale met à jour le nom complet sur l’inscription de stratégie identifiée par la propriété ID de $PolicyEnrollment.

Exemple 2 : Mettre à jour via le pipeline

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

La première commande obtient l’inscription de stratégie nommée PolicyEnrollment07 à l’aide de l’applet de commande Get-AzPolicyEnrollment et la stocke dans la variable $PolicyEnrollment. La deuxième commande définit un nouveau nom d’affichage sur l’objet $PolicyEnrollment. La commande finale canalise l’objet modifié pour Update-AzPolicyEnrollment pour conserver la modification.

Exemple 3 : Mettre à jour le sélecteur de ressources

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

La première commande obtient un groupe de ressources nommé ResourceGroup11 à l’aide de l’applet de commande Get-AzResourceGroup. La deuxième commande crée un objet sélecteur de ressources qui limite l’inscription aux ressources dans des emplacements autres que usa Est ou USA Est 2 et les stocke dans la variable $ResourceSelector. La commande finale met à jour l’inscription de stratégie nommée VirtualMachinePolicyEnrollment avec le sélecteur de ressources spécifié par $ResourceSelector.

Paramètres

-AssignmentScopeValidation

La possibilité de valider l’inscription se situe au niveau ou sous le champ d’application de l’affectation.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-DefaultProfile

Le paramètre DefaultProfile n’est pas fonctionnel. Utilisez le paramètre SubscriptionId lorsqu’il est disponible si vous exécutez l’applet de commande sur un autre abonnement.

Propriétés du paramètre

Type:PSObject
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzureRMContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Description

La description de l’inscription à la police.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-DisplayName

Le nom affiché de l’inscription à la police.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Id

ID de l’inscription de stratégie à mettre à jour. Utilisez le format « {scope}/providers/Microsoft. Authorization/policyEnrollments/{policyEnrollmentName}'.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:ResourceId

Jeux de paramètres

UpdateById
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-InputObject

Objet Inscription de stratégie à mettre à jour.

Propriétés du paramètre

Type:IPolicyEnrollment
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateByInputObject
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Metadata

Les métadonnées d’inscription aux politiques. Les métadonnées sont un objet ouvert et sont généralement une collection de paires clé-valeur.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Name

Le nom de l’inscription à la police.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:PolicyEnrollmentName

Jeux de paramètres

UpdateByNameAndScope
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-PolicyDefinitionReferenceId

Lorsque l’attribution de stratégie associée concerne un jeu de stratégies (initiative), vous pouvez l’utiliser pour spécifier les ID de référence de définition de stratégie pour les définitions de stratégie dans l’ensemble de stratégies à inscrire. Ces identifiants correspondent à un sous-ensemble de policyDefinitions[*].policyDefinitionReferenceId dans la définition de l’ensemble de politiques. Lorsqu’elles sont spécifiées et non vides, seules les définitions de police référencées seront inscrites. Sinon, l’ensemble de stratégies est inscrit.

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ResourceSelector

Liste de sélecteurs de ressources pour filtrer les stratégies par propriétés de ressource.

Propriétés du paramètre

Type:

IResourceSelector[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Scope

Étendue de l’inscription de stratégie. Les étendues valides sont les suivantes : groupe d'administration (format : '/providers/Microsoft. Management/managementGroups/{managementGroup}'), abonnement (format : '/subscriptions/{subscriptionId}'), groupe de ressources (format : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'), ou ressource (format : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}')

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UpdateByNameAndScope
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres communs : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

IPolicyEnrollment

IResourceSelector

String

String

Sorties

IPolicyEnrollment