Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Representa um principal de esquema de identidade de agente num inquilino. Um principal de esquema de identidade do agente é instanciado a partir de um objeto agentIdentityBlueprintPrincipal e é utilizado para criar identidades de agente num inquilino Microsoft Entra ID e executar várias operações de gestão de identidades que afetam todas as identidades de agente criadas.
Herda do servicePrincipal.
Este recurso é um tipo aberto que permite propriedades adicionais para além das documentadas aqui.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| List | agentIdentityBlueprintPrincipal collection (coleção agentIdentityBlueprintPrincipal ) | Obtenha uma lista dos objetos agentIdentityBlueprintPrincipal e respetivas propriedades. |
| Create | agentIdentityBlueprintPrincipal | Crie um novo objeto agentIdentityBlueprintPrincipal. |
| Get | agentIdentityBlueprintPrincipal | Leia as propriedades e relações do objeto agentIdentityBlueprintPrincipal . |
| Atualizar | agentIdentityBlueprintPrincipal | Atualize as propriedades de um objeto agentIdentityBlueprintPrincipal. |
| Delete | Nenhum | Elimine um objeto agentIdentityBlueprintPrincipal. |
| Atribuição de funções do aplicativo | ||
| Listar a função de aplicação atribuída a | appRoleAssignment collection | Obtenha as funções de aplicação atribuídas aos utilizadores, grupos e identidades de agente para este principal de esquema de identidade do agente. |
| Adicionar função de aplicação atribuída a | appRoleAssignment | Atribua uma função de aplicação para este principal de esquema de identidade do agente a um utilizador, grupo ou principal de serviço. |
| Remover a função de aplicação atribuída a | Nenhum | Remova uma atribuição de função de aplicação para este principal de esquema de identidade do agente de um utilizador, grupo ou principal de serviço. |
| Listar atribuições de funções de aplicações | appRoleAssignment collection | Obtenha as funções de aplicação atribuídas a este principal de esquema de identidade do agente. |
| Adicionar atribuição de função de aplicação | appRoleAssignment | Atribua uma função de aplicação a este principal de esquema de identidade do agente. |
| Remover atribuição de função de aplicação | Nenhum | Remova uma atribuição de função de aplicação deste principal de esquema de identidade do agente. |
| Concessões de permissão delegadas | ||
| Listar concessões de permissões do OAuth 2.0 | oAuth2PermissionGrant collection | Obtenha as permissões delegadas que autorizam este principal de esquema de identidade do agente a aceder a uma API em nome de um utilizador com sessão iniciada. |
| Itens excluídos | ||
| List | Coleção directoryObject | Obtenha uma lista de identidades de agentes eliminadas recentemente. |
| Get | directoryObject | Obtenha as propriedades de uma identidade de agente eliminada recentemente. |
| Restaurar | directoryObject | Restaurar uma identidade de agente eliminada recentemente. |
| Excluir permanentemente | Nenhum | Eliminar permanentemente uma identidade de agente. |
| Objetos de diretório | ||
| Listar objetos de propriedade | Coleção directoryObject | Obter objetos de diretório pertencentes a este principal de esquema de identidade do agente. |
| Listar objetos criados | Coleção directoryObject | Obtenha objetos de diretório criados por este principal de esquema de identidade do agente. |
| Associações | ||
| Listar membro de | Coleção directoryObject | Obtenha os grupos dos quais este principal de esquema de identidade do agente é um membro direto. |
| Owners | ||
| Listar proprietários | Coleção directoryObject | Obtenha os proprietários deste principal de esquema de identidade do agente. |
| Adicionar proprietários | Nenhum | Atribua um proprietário a este principal de esquema de identidade do agente. |
| Remover proprietários | Nenhum | Remova um proprietário deste principal de esquema de identidade do agente. |
| Patrocinadores | ||
| Listar patrocinadores | Coleção directoryObject | Obtenha os patrocinadores deste principal de esquema de identidade de agente. |
| Adicionar patrocinadores | directoryObject | Adicione patrocinadores publicando na coleção de patrocinadores. |
| Remover patrocinadores | Nenhum | Remover um objeto directoryObject . |
Propriedades
Importante
Embora este recurso herda de servicePrincipal, algumas propriedades não são aplicáveis e devolvem null ou são valores predefinidos. Estas propriedades são excluídas da tabela abaixo.
| Propriedade | Tipo | Descrição |
|---|---|---|
| accountEnabled | Booliano |
true se a conta principal do esquema de identidade do agente estiver ativada; caso contrário, false. Se estiver definido falsecomo , os utilizadores não poderão iniciar sessão nesta aplicação, mesmo que estejam atribuídos à mesma. Herdado do servicePrincipal. |
| appDescription | String | A descrição exposta pelo esquema de identidade do agente associado. Herdado do servicePrincipal. |
| appDisplayName | Cadeia de caracteres | O nome a apresentar exposto pelo esquema de identidade do agente associado. O comprimento máximo é de 256 caracteres. Herdado do servicePrincipal. |
| appId | Cadeia de caracteres | O appId do esquema de identidade do agente associado. Chave alternativa. Herdado do servicePrincipal. |
| appOwnerOrganizationId | Guid | Contém o ID do inquilino onde o esquema de identidade do agente está registado. Isto aplica-se apenas aos principais de esquema de identidade do agente apoiados por aplicações. Herdado do servicePrincipal. |
| appRoleAssignmentRequired | Booliano | Especifica se é necessário conceder aos utilizadores ou a outros principais de serviço uma atribuição de função de aplicação para este principal de esquema de identidade do agente antes de os utilizadores poderem iniciar sessão ou as aplicações poderem obter tokens. O valor padrão é false. Não anulável. Herdado do servicePrincipal. |
| appRoles | Coleção appRole | As funções expostas pelo esquema de identidade do agente, que este principal de esquema de identidade do agente representa. Para obter mais informações, veja a definição da propriedade appRoles na entidade da aplicação. Não anulável. Herdado do servicePrincipal. |
| createdByAppId | Cadeia de caracteres | O appId (denominado ID da aplicação (cliente) na centro de administração do Microsoft Entra) da aplicação que criou este principal de esquema de identidade do agente. Definir internamente por Microsoft Entra ID. Somente leitura. Herdado do servicePrincipal. |
| disabledByMicrosoftStatus | Cadeia de caracteres | Especifica se a Microsoft desativou o esquema de identidade do agente registado. Os valores possíveis são: null (valor predefinido), NotDisablede DisabledDueToViolationOfServicesAgreement (os motivos podem incluir atividades suspeitas, abusivas ou maliciosas ou uma violação do Contrato de Serviços Microsoft). Herdado do servicePrincipal. |
| displayName | Cadeia de caracteres | O nome a apresentar do principal de esquema de identidade do agente. Herdado do servicePrincipal. |
| id | Cadeia de caracteres | O identificador exclusivo do principal de esquema de identidade do agente. Herdado da entidade. Chave. Não anulável. Somente leitura. |
| informações | informationalUrl | Informações básicas de perfil do aplicativo adquirido, como marketing, suporte, termos de serviço e URLs de política de privacidade do aplicativo. Os termos de serviço e a política de privacidade são revelados aos usuários por meio da experiência de consentimento do usuário. Herdado do servicePrincipal. |
| publishedPermissionScopes | coleção permissionScope | As permissões delegadas expostas pelo aplicativo. Para obter mais informações, veja a propriedade oauth2PermissionScopes na propriedade api da entidade de esquema de identidade do agente. Não anulável. Herdado do servicePrincipal. |
| publisherName | String | O nome do inquilino Microsoft Entra que publicou a aplicação. Herdado do servicePrincipal. |
| servicePrincipalNames | String collection | Contém a lista de identifiersUris, copiados do esquema de identidade do agente associado. Podem ser adicionados mais valores ao esquema de identidade do agente híbrido. Estes valores podem ser utilizados para identificar as permissões expostas por esta aplicação no Microsoft Entra ID. Não anulável. Propriedade bloqueada no Principal de Esquema de Identidade do Agente. Herdado do servicePrincipal. |
| servicePrincipalType | Cadeia de caracteres | Identifica se o principal de esquema de identidade do agente representa uma aplicação. Esta definição é definida por Microsoft Entra ID internamente. Para um principal de esquema de identidade do agente que representa uma aplicação, isto é definido como Aplicação. Herdado do servicePrincipal. |
| signInAudience | Cadeia de caracteres | Especifica as contas Microsoft que são suportadas para o esquema de identidade do agente atual. Somente leitura. Os valores suportados são: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccounte PersonalMicrosoftAccount. Herdado do servicePrincipal. |
| tags | String collection | Cadeias personalizadas que podem ser utilizadas para categorizar e identificar o principal de esquema de identidade do agente. Não anulável. O valor é a união de cadeias definida aqui e na propriedade de etiquetas do esquema de identidade do agente associada. Herdado do servicePrincipal. |
| verifiedPublisher | verifiedPublisher | Especifica o publicador verificado da aplicação que está ligada a este principal de esquema de identidade do agente. Herdado do servicePrincipal. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| appManagementPolicies | appManagementPolicy collection | AppManagementPolicy aplicado a este principal de esquema de identidade do agente. Herdado de microsoft.graph.servicePrincipal |
| appRoleAssignedTo | appRoleAssignment collection | Atribuições de funções de aplicação para este principal de esquema de identidade do agente, concedidas a utilizadores, grupos e outros principais de serviço. Oferece suporte para $expand. Herdado de microsoft.graph.servicePrincipal |
| appRoleAssignments | appRoleAssignment collection | Atribuição de função de aplicação para outra aplicação ou serviço, concedida a este principal de esquema de identidade do agente. Oferece suporte para $expand. Herdado de microsoft.graph.servicePrincipal |
| createdObjects | Coleção directoryObject | Objetos de diretório criados por este principal de esquema de identidade do agente. Somente leitura. Anulável. Herdado de microsoft.graph.servicePrincipal |
| memberOf | Coleção directoryObject | Funções das quais este principal de esquema de identidade do agente é membro. Métodos HTTP: GET somente leitura. Anulável. Suporta o $expand. Herdado de microsoft.graph.servicePrincipal |
| oauth2PermissionGrants | oAuth2PermissionGrant collection | A permissão delegada concede autorização a este principal de esquema de identidade do agente para aceder a uma API em nome de um utilizador com sessão iniciada. Somente leitura. Anulável. Herdado de microsoft.graph.servicePrincipal |
| ownedObjects | Coleção directoryObject | Objetos de diretório pertencentes a este principal de esquema de identidade do agente. Somente leitura. Anulável.
$expand Suporta e $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). Herdado de microsoft.graph.servicePrincipal |
| owners | Coleção directoryObject | Objetos de diretório que são proprietários deste principal de esquema de identidade do agente. Os proprietários são um conjunto de utilizadores não administradores ou servicePrincipals que têm permissão para modificar este objeto.
$expand Suporta e $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). Herdado de microsoft.graph.servicePrincipal |
| patrocinadores | Coleção directoryObject | Os patrocinadores deste principal de esquema de identidade de agente. Os patrocinadores são utilizadores ou principais de serviço que podem autorizar e gerir o ciclo de vida das instâncias de identidade do agente. |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso. Apenas um subconjunto de todas as propriedades é devolvido por predefinição. Todas as outras propriedades só podem ser obtidas com $select.
{
"@odata.type": "#microsoft.graph.agentIdentityBlueprintPrincipal",
"id": "String (identifier)",
"accountEnabled": "Boolean",
"createdByAppId": "String",
"appDescription": "String",
"appDisplayName": "String",
"appId": "String",
"appOwnerOrganizationId": "Guid",
"appRoleAssignmentRequired": "Boolean",
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"publisherName": "String",
"servicePrincipalNames": [
"String"
],
"servicePrincipalType": "String",
"signInAudience": "String",
"tags": [
"String"
],
"appRoles": [
{
"@odata.type": "microsoft.graph.appRole"
}
],
"info": {
"@odata.type": "microsoft.graph.informationalUrl"
},
"publishedPermissionScopes": [
{
"@odata.type": "microsoft.graph.permissionScope"
}
],
"verifiedPublisher": {
"@odata.type": "microsoft.graph.verifiedPublisher"
}
}