Remove-AzRoleDefinition

Módulo:
Az.Resources Module

Exclui uma função personalizada no RBAC Azure. A função a ser excluída é especificada usando a propriedade ID da função. A exclusão falhará se houver atribuições de função existentes feitas à função personalizada.

Sintaxe

RoleDefinitionIdParameterSet (Default) 

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

O cmdlet Remove-AzRoleDefinition exclui uma função personalizada no Azure Role-Based Controle de Acesso. Forneça o parâmetro de ID de uma função personalizada existente para excluir essa função personalizada. Por padrão, Remove-AzRoleDefinition solicita confirmação. Para suprimir o prompt, use o parâmetro Force. Se houver atribuições de função existentes feitas para a função personalizada a ser excluída, a exclusão falhará.

Ao usar o parâmetro -PassThru, o cmdlet retorna o objeto PSRoleDefinition excluído. O objeto retornado contém uma coleção Permissions com Actions, NotActions, DataActions, NotDataActions e quaisquer condições de Attribute-Based Controle de Acesso (ABAC) (Condição e ConditionVersion) para cada entrada de permissão.

Exemplos

Exemplo 1: remover uma função personalizada por meio da tubulação de Get-AzRoleDefinition

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

Recupera a função personalizada "Operador de Máquina Virtual" e a redireciona para Remove-AzRoleDefinition para exclusão. Você será solicitado a confirmar antes que a função seja excluída.

Exemplo 2: remover uma função personalizada por Id

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

Exclui a função personalizada com a ID especificada. Você será solicitado a confirmar.

Exemplo 3: remover uma função personalizada sem confirmação

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

Exclui a função personalizada chamada "Função de Leitor Personalizado" sem solicitar confirmação.

Exemplo 4: Remover e retornar a definição de função excluída

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

Exclui a função e retorna o objeto PSRoleDefinition e exibe as ações da primeira entrada de permissão.

Parâmetros

-AcquirePolicyToken

Adquira um token de Azure Policy automaticamente para esta operação de recurso.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ChangeReference

A ID do recurso de referência de alteração para esta operação de recurso.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Se definido, não solicitará uma confirmação antes de excluir a função personalizada

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Id

ID da definição de função a ser excluída

Propriedades do parâmetro

Tipo:Guid
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

RoleDefinitionIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-InputObject

O objeto que representa a definição de função a ser removida.

Propriedades do parâmetro

Tipo:PSRoleDefinition
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

InputObjectParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

Nome da definição de função a ser excluída.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

RoleDefinitionNameParameterSet
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-PassThru

O cmdlet Remove-AzRoleDefinition exclui uma função personalizada no Azure Role-Based Controle de Acesso. Forneça o parâmetro de ID de uma função personalizada existente para excluir essa função personalizada. Por padrão, Remove-AzRoleDefinition solicita confirmação. Para suprimir o prompt, use o parâmetro Force. Se houver atribuições de função existentes feitas para a função personalizada a ser excluída, a exclusão falhará.

Ao usar o parâmetro -PassThru, o cmdlet retorna o objeto PSRoleDefinition excluído. O objeto retornado contém uma coleção Permissions com Actions, NotActions, DataActions, NotDataActions e quaisquer condições de Attribute-Based Controle de Acesso (ABAC) (Condição e ConditionVersion) para cada entrada de permissão.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Scope

Escopo de definição de função.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

RoleDefinitionIdParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
RoleDefinitionNameParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SkipClientSideScopeValidation

Se especificado, ignore a validação do escopo do lado do cliente.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

O cmdlet Remove-AzRoleDefinition exclui uma função personalizada no Azure Role-Based Controle de Acesso. Forneça o parâmetro de ID de uma função personalizada existente para excluir essa função personalizada. Por padrão, Remove-AzRoleDefinition solicita confirmação. Para suprimir o prompt, use o parâmetro Force. Se houver atribuições de função existentes feitas para a função personalizada a ser excluída, a exclusão falhará.

Ao usar o parâmetro -PassThru, o cmdlet retorna o objeto PSRoleDefinition excluído. O objeto retornado contém uma coleção Permissions com Actions, NotActions, DataActions, NotDataActions e quaisquer condições de Attribute-Based Controle de Acesso (ABAC) (Condição e ConditionVersion) para cada entrada de permissão.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

Guid

String

PSRoleDefinition

Saídas

Boolean

Observações

Palavras-chave: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment