Remove-AzRoleDefinition

Module:
Az.Resources Module

Supprime un rôle personnalisé dans Azure RBAC. Le rôle à supprimer est spécifié à l’aide de la propriété ID du rôle. La suppression échoue si des attributions de rôle existantes sont apportées au rôle personnalisé.

Syntaxe

RoleDefinitionIdParameterSet (Par défaut) 

Remove-AzRoleDefinition
    -Id <Guid>
    [-Scope <String>]
    [-SkipClientSideScopeValidation]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

RoleDefinitionNameParameterSet 

Remove-AzRoleDefinition
    [-Name] <String>
    [-Scope <String>]
    [-SkipClientSideScopeValidation]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

InputObjectParameterSet 

Remove-AzRoleDefinition
    -InputObject <PSRoleDefinition>
    [-SkipClientSideScopeValidation]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

Description

L’applet de commande Remove-AzRoleDefinition supprime un rôle personnalisé dans Azure Role-Based Access Control. Indiquez le paramètre ID d’un rôle personnalisé existant pour supprimer ce rôle personnalisé. Par défaut, Remove-AzRoleDefinition vous invite à confirmer. Pour supprimer l’invite, utilisez le paramètre Force. S’il existe des attributions de rôles existantes apportées au rôle personnalisé à supprimer, la suppression échoue.

Lorsque vous utilisez le paramètre -PassThru, l’applet de commande retourne l’objet PSRoleDefinition supprimé. L’objet retourné contient une collection Permissions avec Actions, NotActions, DataActions, NotDataActions et toutes les conditions Attribute-Based Access Control (ABAC) (Condition et ConditionVersion) pour chaque entrée d’autorisation.

Exemples

Exemple 1 : Supprimer un rôle personnalisé en piping de Get-AzRoleDefinition

Get-AzRoleDefinition -Name "Virtual Machine Operator" | Remove-AzRoleDefinition

Récupère le rôle personnalisé « Opérateur de machine virtuelle » et le dirige vers Remove-AzRoleDefinition pour suppression. Vous serez invité à confirmer la suppression du rôle.

Exemple 2 : Supprimer un rôle personnalisé par ID

Remove-AzRoleDefinition -Id "00001111-aaaa-2222-bbbb-3333cccc4444"

Supprime le rôle personnalisé avec l’ID spécifié. Vous serez invité à confirmer.

Exemple 3 : Supprimer un rôle personnalisé sans confirmation

Remove-AzRoleDefinition -Name "Custom Reader Role" -Force

Supprime le rôle personnalisé nommé « Rôle lecteur personnalisé » sans demander de confirmation.

Exemple 4 : Supprimer et retourner la définition de rôle supprimée

$deletedRole = Remove-AzRoleDefinition -Name "Custom Writer Role" -Force -PassThru
$deletedRole.Permissions[0].Actions

Supprime le rôle et retourne l’objet PSRoleDefinition, puis affiche les actions de la première entrée d’autorisation.

Paramètres

-AcquirePolicyToken

Acquérir automatiquement un jeton Azure Policy pour cette opération de ressource.

Propriétés du paramètre

Type:SwitchParameter
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é:False
Valeur des arguments restants:False

-ChangeReference

ID de ressource de référence de modification pour cette opération de ressource.

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é:False
Valeur des arguments restants:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

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

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

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, 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

-Force

Si cette option est définie, n’invite pas à confirmer la suppression du rôle personnalisé

Propriétés du paramètre

Type:SwitchParameter
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é:False
Valeur des arguments restants:False

-Id

ID de la définition de rôle à supprimer

Propriétés du paramètre

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

Jeux de paramètres

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

-InputObject

Objet représentant la définition de rôle à supprimer.

Propriétés du paramètre

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

Jeux de paramètres

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

-Name

Nom de la définition de rôle à supprimer.

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

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

-PassThru

L’applet de commande Remove-AzRoleDefinition supprime un rôle personnalisé dans Azure Role-Based Access Control. Indiquez le paramètre ID d’un rôle personnalisé existant pour supprimer ce rôle personnalisé. Par défaut, Remove-AzRoleDefinition vous invite à confirmer. Pour supprimer l’invite, utilisez le paramètre Force. S’il existe des attributions de rôles existantes apportées au rôle personnalisé à supprimer, la suppression échoue.

Lorsque vous utilisez le paramètre -PassThru, l’applet de commande retourne l’objet PSRoleDefinition supprimé. L’objet retourné contient une collection Permissions avec Actions, NotActions, DataActions, NotDataActions et toutes les conditions Attribute-Based Access Control (ABAC) (Condition et ConditionVersion) pour chaque entrée d’autorisation.

Propriétés du paramètre

Type:SwitchParameter
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é:False
Valeur des arguments restants:False

-Scope

Étendue de définition de rôle.

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

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

-SkipClientSideScopeValidation

Si elle est spécifiée, ignorez la validation de l’étendue côté client.

Propriétés du paramètre

Type:SwitchParameter
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é:False
Valeur des arguments restants:False

-WhatIf

L’applet de commande Remove-AzRoleDefinition supprime un rôle personnalisé dans Azure Role-Based Access Control. Indiquez le paramètre ID d’un rôle personnalisé existant pour supprimer ce rôle personnalisé. Par défaut, Remove-AzRoleDefinition vous invite à confirmer. Pour supprimer l’invite, utilisez le paramètre Force. S’il existe des attributions de rôles existantes apportées au rôle personnalisé à supprimer, la suppression échoue.

Lorsque vous utilisez le paramètre -PassThru, l’applet de commande retourne l’objet PSRoleDefinition supprimé. L’objet retourné contient une collection Permissions avec Actions, NotActions, DataActions, NotDataActions et toutes les conditions Attribute-Based Access Control (ABAC) (Condition et ConditionVersion) pour chaque entrée d’autorisation.

Propriétés du paramètre

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

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

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

Guid

String

PSRoleDefinition

Sorties

Boolean

Notes

Mots clés : azure, azurerm, arm, resource, management, manager, resource, group, template, deployment