New-EntraDirectoryRoleDefinition

Módulo:
Microsoft.Entra.Governance Module v1.3

Crie um novo Microsoft Entra ID roleDefinition.

Sintaxe

Default (Default) 

New-EntraDirectoryRoleDefinition

    [-TemplateId <String>]
    -DisplayName <String>
    -RolePermissions <System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RolePermission]>
    [-Description <String>]
    [-Version <String>]
    -IsEnabled <Boolean>
    [-ResourceScopes <System.Collections.Generic.List`1[System.String]>]
    [<CommonParameters>]

Description

Crie um novo objeto Microsoft Entra ID roleDefinition.

Em cenários delegados, o usuário conectado deve ter uma função de Microsoft Entra com suporte ou uma função personalizada com as permissões necessárias. As funções mínimas necessárias para esta operação são:

  • Administrador de Função Privilégiada

Exemplos

Exemplo 1: Cria uma nova definição de função

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$rolePermissions = New-object Microsoft.Open.MSGraph.Model.RolePermission
$rolePermissions.AllowedResourceActions = @("microsoft.directory/applications/basic/read")
New-EntraDirectoryRoleDefinition -RolePermissions $rolePermissions -IsEnabled $false -DisplayName 'MyRoleDefinition'


DisplayName      Id                                   TemplateId                           Description IsBuiltIn IsEnabled
-----------      --                                   ----------                           ----------- --------- ---------
MyRoleDefinition a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 93ff7659-04bd-4d97-8add-b6c992cce98e             False     False

Esse comando cria uma nova definição de função no Microsoft Entra ID.

  • -RolePermissions o parâmetro especifica as permissões para a definição de função.
  • -IsEnabled o parâmetro especifica se a definição de função está habilitada.
  • -DisplayName o parâmetro especifica o nome de exibição para a definição de função.

Exemplo 2: Cria uma nova definição de função com o parâmetro Description

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$rolePermissions = New-object Microsoft.Open.MSGraph.Model.RolePermission
$rolePermissions.AllowedResourceActions = @("microsoft.directory/applications/basic/read")
New-EntraDirectoryRoleDefinition -RolePermissions $rolePermissions -IsEnabled $false -DisplayName 'MyRoleDefinition' -Description 'Role Definition demo'


DisplayName      Id                                   TemplateId                           Description          IsBuiltIn IsEnabled
-----------      --                                   ----------                           -----------          --------- ---------
MyRoleDefinition a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 e14cb8e2-d696-4756-bd7f-c7df25271f3d Role Definition demo False     False

Esse comando cria uma nova definição de função com o parâmetro Description.

  • -RolePermissions o parâmetro especifica as permissões para a definição de função.
  • -IsEnabled o parâmetro especifica se a definição de função está habilitada.
  • -DisplayName o parâmetro especifica o nome de exibição para a definição de função.
  • -Description o parâmetro especifica a descrição da definição de função.

Exemplo 3: Cria uma nova definição de função com o parâmetro ResourceScopes

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$rolePermissions = New-object Microsoft.Open.MSGraph.Model.RolePermission
$rolePermissions.AllowedResourceActions = @("microsoft.directory/applications/basic/read")
New-EntraDirectoryRoleDefinition -RolePermissions $rolePermissions -IsEnabled $false -DisplayName 'MyRoleDefinition' -ResourceScopes '/'

DisplayName      Id                                   TemplateId                           Description IsBuiltIn IsEnabled
-----------      --                                   ----------                           ----------- --------- ---------
MyRoleDefinition a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 2bc29892-ca2e-457e-b7c0-03257a0bcd0c             False     False

Esse comando cria uma nova definição de função com o parâmetro ResourceScopes.

  • -RolePermissions o parâmetro especifica as permissões para a definição de função.
  • -IsEnabled o parâmetro especifica se a definição de função está habilitada.
  • -DisplayName o parâmetro especifica o nome de exibição para a definição de função.
  • -ResourceScopes o parâmetro especifica os escopos de recurso para a definição de função.

Exemplo 4: Cria uma nova definição de função com o parâmetro TemplateId

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$rolePermissions = New-object Microsoft.Open.MSGraph.Model.RolePermission
$rolePermissions.AllowedResourceActions = @("microsoft.directory/applications/basic/read")
New-EntraDirectoryRoleDefinition -RolePermissions $rolePermissions -IsEnabled $false -DisplayName 'MyRoleDefinition' -TemplateId 'f2ef992c-3afb-46b9-b7cf-a126ee74c451'

DisplayName      Id                                   TemplateId                           Description IsBuiltIn IsEnabled
-----------      --                                   ----------                           ----------- --------- ---------
MyRoleDefinition a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 f2ef992c-3afb-46b9-b7cf-a126ee74c451             False     False

Esse comando cria uma nova definição de função com o parâmetro TemplateId.

  • -RolePermissions o parâmetro especifica as permissões para a definição de função.
  • -IsEnabled o parâmetro especifica se a definição de função está habilitada.
  • -DisplayName o parâmetro especifica o nome de exibição para a definição de função.
  • -TemplateId o parâmetro especifica a ID do modelo para a definição de função.

Exemplo 5: Cria uma nova definição de função com o parâmetro Version

Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$rolePermissions = New-object Microsoft.Open.MSGraph.Model.RolePermission
$rolePermissions.AllowedResourceActions = @("microsoft.directory/applications/basic/read")
New-EntraDirectoryRoleDefinition -RolePermissions $rolePermissions -IsEnabled $false -DisplayName 'MyRoleDefinition' -Version '2'

DisplayName      Id                                   TemplateId                           Description IsBuiltIn IsEnabled
-----------      --                                   ----------                           ----------- --------- ---------
MyRoleDefinition a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 b69d16e9-b3f9-4289-a87f-8f796bd9fa28             False     False

Esse comando cria uma nova definição de função com o parâmetro Version.

  • -RolePermissions o parâmetro especifica as permissões para a definição de função.
  • -IsEnabled o parâmetro especifica se a definição de função está habilitada.
  • -DisplayName o parâmetro especifica o nome de exibição para a definição de função.
  • -Version o parâmetro especifica a versão para a definição de função.

Parâmetros

-Description

Especifica uma descrição para a definição de função.

Propriedades do parâmetro

Tipo:System.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

-DisplayName

Especifica um nome a apresentar para a definição de função.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-IsEnabled

Especifica se a definição de função está ativada. Sinalizador a indicar se a função está ativada para atribuição. Se for false, a função não estará disponível para atribuição. Somente leitura quando isBuiltIn for verdadeiro.

Propriedades do parâmetro

Tipo:System.Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

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

-ResourceScopes

Especifica os âmbitos de recursos para a definição de função.

Propriedades do parâmetro

Tipo:

System.Collections.Generic.List`1[System.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

-RolePermissions

Especifica permissões para a definição de função.

Propriedades do parâmetro

Tipo:

System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RolePermission]

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

Conjuntos de parâmetros

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

-TemplateId

Especifica a ID do modelo para a definição de função.

Propriedades do parâmetro

Tipo:System.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

-Version

Especifica a versão para a definição de função.

Propriedades do parâmetro

Tipo:System.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

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.

Saídas

Microsoft.Open.MSGraph.Model.DirectoryRoleDefinition

Observações

New-EntraRoleDefinition é um alias para New-EntraDirectoryRoleDefintion.