Remove-AzRoleAssignment

Módulo:
Az.Resources Module

Remove uma atribuição de função para a entidade de segurança especificada que é atribuída a uma função específica em um escopo específico.

O cmdlet pode chamar abaixo da API do Microsoft Graph de acordo com os parâmetros de entrada:

  • GET /users/{id}
  • GET /servicePrincipals/{id}
  • GET /groups/{id}
  • GET /directoryObjects/{id}
  • POST /directoryObjects/getByIds

Observe que esse cmdlet marcará ObjectType como Unknown na saída se o objeto da atribuição de função não for encontrado ou a conta atual tiver privilégios insuficientes para obter o tipo de objeto.

Sintaxe

EmptyParameterSet (Default) 

Remove-AzRoleAssignment
    -ObjectId <String>
    -RoleDefinitionName <String>
    [-Scope <String>]
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceWithObjectIdParameterSet 

Remove-AzRoleAssignment
    -ObjectId <String>
    -ResourceGroupName <String>
    -ResourceName <String>
    -ResourceType <String>
    -RoleDefinitionName <String>
    [-ParentResource <String>]
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceGroupWithObjectIdParameterSet 

Remove-AzRoleAssignment
    -ObjectId <String>
    -ResourceGroupName <String>
    -RoleDefinitionName <String>
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ScopeWithObjectIdParameterSet 

Remove-AzRoleAssignment
    -ObjectId <String>
    -RoleDefinitionName <String>
    [-Scope <String>]
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

RoleIdWithScopeAndObjectIdParameterSet 

Remove-AzRoleAssignment
    -ObjectId <String>
    -RoleDefinitionId <Guid>
    [-Scope <String>]
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceWithSignInNameParameterSet 

Remove-AzRoleAssignment
    -SignInName <String>
    -ResourceGroupName <String>
    -ResourceName <String>
    -ResourceType <String>
    -RoleDefinitionName <String>
    [-ParentResource <String>]
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceGroupWithSignInNameParameterSet 

Remove-AzRoleAssignment
    -SignInName <String>
    -ResourceGroupName <String>
    -RoleDefinitionName <String>
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ScopeWithSignInNameParameterSet 

Remove-AzRoleAssignment
    -SignInName <String>
    -RoleDefinitionName <String>
    [-Scope <String>]
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceWithSPNParameterSet 

Remove-AzRoleAssignment
    -ServicePrincipalName <String>
    -ResourceGroupName <String>
    -ResourceName <String>
    -ResourceType <String>
    -RoleDefinitionName <String>
    [-ParentResource <String>]
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceGroupWithSPNParameterSet 

Remove-AzRoleAssignment
    -ServicePrincipalName <String>
    -ResourceGroupName <String>
    -RoleDefinitionName <String>
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ScopeWithSPNParameterSet 

Remove-AzRoleAssignment
    -ServicePrincipalName <String>
    -RoleDefinitionName <String>
    [-Scope <String>]
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

RoleAssignmentParameterSet 

Remove-AzRoleAssignment
    [-InputObject] <PSRoleAssignment>
    [-PassThru]
    [-SkipClientSideScopeValidation]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use o comando Remove-AzRoleAssignment para revogar o acesso a qualquer entidade de segurança em determinado escopo e função fornecida. O objeto da atribuição, ou seja, a entidade de segurança DEVE ser especificada. A entidade de segurança pode ser um usuário (use parâmetros SignInName ou ObjectId para identificar um usuário), grupo de segurança (usar parâmetro ObjectId para identificar um grupo) ou entidade de serviço (use parâmetros ServicePrincipalName ou ObjectId para identificar um ServicePrincipal. A função à qual a entidade de segurança é atribuída DEVE ser especificada usando o parâmetro RoleDefinitionName. O escopo da atribuição PODE ser especificado e, se não for especificado, o padrão é o escopo da assinatura, ou seja, ele tentará excluir uma atribuição para a entidade de segurança e a função especificadas no escopo da assinatura. O escopo da atribuição pode ser especificado usando um dos parâmetros a seguir. a. Escopo – esse é o escopo totalmente qualificado começando com /subscriptions/<subscriptionId> b. ResourceGroupName – Nome de qualquer grupo de recursos na assinatura. c. ResourceName, ResourceType, ResourceGroupName e (opcionalmente) ParentResource – identifica um recurso específico na assinatura.

Exemplos

Exemplo 1

Remove-AzRoleAssignment -ResourceGroupName rg1 -SignInName john.doe@contoso.com -RoleDefinitionName Reader

Remove uma atribuição de função para john.doe@contoso.com quem está atribuído à função Leitor no escopo do grupo de recursos rg1.

Exemplo 2

Remove-AzRoleAssignment -ObjectId aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb -RoleDefinitionName Reader

Remove a atribuição de função para a entidade de grupo identificada pela ObjectId e atribuída à função Leitor. O padrão é usar a assinatura atual como o escopo para localizar a atribuição a ser excluída.

Exemplo 3

$roleassignment = Get-AzRoleAssignment |Select-Object -First 1 -Wait
Remove-AzRoleAssignment -InputObject $roleassignment

Remove o primeiro objeto de atribuição de função que é buscado do commandlet Get-AzRoleAssignment.

Parâmetros

-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 usados 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

-InputObject

Objeto Role Assignment.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-ObjectId

Microsoft Entra ObjectId do usuário, grupo ou entidade de serviço.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:ID, PrincipalId

Conjuntos de parâmetros

EmptyParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceWithObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceGroupWithObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ScopeWithObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
RoleIdWithScopeAndObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ParentResource

O recurso pai na hierarquia(do recurso especificado usando o parâmetro ResourceName), se houver. Deve ser usado em conjunto com os parâmetros ResourceGroupName, ResourceType e ResourceName para construir um escopo hierárquico na forma de um URI relativo que identifique o recurso.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-PassThru

Se especificado, exibe a atribuição de função excluída

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

-ResourceGroupName

O nome do grupo de recursos ao qual a função é atribuída. Tenta excluir uma atribuição no escopo do grupo de recursos especificado. Quando usado em conjunto com parâmetros ResourceName, ResourceType e (opcionalmente)ParentResource, o comando constrói um escopo hierárquico na forma de um URI relativo que identifica um recurso.

Propriedades do parâmetro

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

Conjuntos de parâmetros

ResourceWithObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceGroupWithObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceWithSignInNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceGroupWithSignInNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceWithSPNParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceGroupWithSPNParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ResourceName

O nome do recurso. Por exemplo, storageaccountprod. Deve ser usado em conjunto com os parâmetros ResourceGroupName, ResourceType e (opcionalmente)ParentResource, para construir um escopo hierárquico na forma de um URI relativo que identifique o recurso e exclua uma atribuição nesse escopo.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-ResourceType

O tipo de recurso. Por exemplo, Microsoft.Network/virtualNetworks. Deve ser usado em conjunto com parâmetros ResourceGroupName, ResourceName e (opcionalmente)ParentResource para construir um escopo hierárquico na forma de um URI relativo que identifique o recurso e exclua uma atribuição nesse escopo de recurso.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-RoleDefinitionId

ID da função RBAC para a qual a atribuição precisa ser excluída.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-RoleDefinitionName

Nome da função RBAC para a qual a atribuição precisa ser excluída, ou seja, Leitor, Colaborador, Administrador de Rede Virtual etc.

Propriedades do parâmetro

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

Conjuntos de parâmetros

EmptyParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceWithObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceGroupWithObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ScopeWithObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceWithSignInNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceGroupWithSignInNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ScopeWithSignInNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceWithSPNParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceGroupWithSPNParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ScopeWithSPNParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Scope

O escopo da atribuição de função a ser excluída. No formato de URI relativo. Por exemplo, "/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG". Se não for especificado, tentará excluir a função no nível da assinatura. Se especificado, ele deve começar com "/subscriptions/{id}".

Propriedades do parâmetro

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

Conjuntos de parâmetros

EmptyParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ScopeWithObjectIdParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
RoleIdWithScopeAndObjectIdParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ScopeWithSignInNameParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ScopeWithSPNParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ServicePrincipalName

O ServicePrincipalName do aplicativo Microsoft Entra

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:SPN, ApplicationId

Conjuntos de parâmetros

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

-SignInName

O endereço de email ou o nome principal do usuário.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Email, Nome Principal do Usuário

Conjuntos de parâmetros

ResourceWithSignInNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ResourceGroupWithSignInNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ScopeWithSignInNameParameterSet
Cargo:Named
Obrigatório:True
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

Use o comando Remove-AzRoleAssignment para revogar o acesso a qualquer entidade de segurança em determinado escopo e função fornecida. O objeto da atribuição, ou seja, a entidade de segurança DEVE ser especificada. A entidade de segurança pode ser um usuário (use parâmetros SignInName ou ObjectId para identificar um usuário), grupo de segurança (usar parâmetro ObjectId para identificar um grupo) ou entidade de serviço (use parâmetros ServicePrincipalName ou ObjectId para identificar um ServicePrincipal. A função à qual a entidade de segurança é atribuída DEVE ser especificada usando o parâmetro RoleDefinitionName. O escopo da atribuição PODE ser especificado e, se não for especificado, o padrão é o escopo da assinatura, ou seja, ele tentará excluir uma atribuição para a entidade de segurança e a função especificadas no escopo da assinatura. O escopo da atribuição pode ser especificado usando um dos parâmetros a seguir. a. Escopo – esse é o escopo totalmente qualificado começando com /subscriptions/<subscriptionId> b. ResourceGroupName – Nome de qualquer grupo de recursos na assinatura. c. ResourceName, ResourceType, ResourceGroupName e (opcionalmente) ParentResource – identifica um recurso específico na assinatura.

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 suporta os 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

String

Guid

PSRoleAssignment

Saídas

PSRoleAssignment

Observações

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