tipo de recurso de domínio

Artigo
05/30/2024

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 domínio associado ao inquilino.

Utilize operações de domínio para associar domínios a um inquilino, verificar a propriedade do domínio e configurar serviços suportados. As operações de domínio permitem que as entidades de registo automatizem a associação de domínio para serviços como o Microsoft 365. Por exemplo, como parte da inscrição de domínios, uma entidade de registo de domínios pode ativar um domínio personalizado para e-mail, sites, autenticação, etc.

Para associar um domínio a um inquilino:

Associar um domínio a um inquilino.
Obter os registos de verificação de domínio. Adicione os detalhes do registo de verificação ao ficheiro de zona do domínio com a configuração do servidor do Sistema de Nomes de Domínio (DNS) ou da entidade de registo de domínios.
Verifique a propriedade do domínio e defina a propriedade isVerified comotrue.
Indique os serviços suportados que planeia utilizar com o domínio.
Configure os serviços suportados ao obter uma lista dos registos necessários para ativar os serviços para o domínio. Adicione os detalhes do registo de configuração ao ficheiro de zona do domínio com a configuração da entidade de registo de domínios ou do servidor DNS.

Métodos

Método	Tipo de retorno	Descrição
List	domain	Obter todos os domínios ligados ao inquilino.
Create	domain	Adicione um domínio ao inquilino.
Get	domain	Ler propriedades e relações de um objeto de domínio.
Atualizar	domain	Atualizar um domínio.
Delete	Nenhum	Eliminar um domínio.
Listar referências de nomes de domínio	Coleção directoryObject	Obtenha uma lista de objetos de diretório com uma referência ao domínio.
Listar registos de configuração do serviço	domainDnsRecord collection	Obtenha uma lista de registos DNS de domínio para configuração de domínio.
Listar registos DNS de verificação	domainDnsRecord collection	Obtenha uma lista de registos DNS de domínio para verificação de domínio.
Referência de nome de domínio de lista	Coleção directoryObject	Obtenha uma lista de objetos de diretório com uma referência ao domínio.
Listar registos de configuração do serviço	domainDnsRecord collection	Obtenha uma lista de registos DNS de domínio para configuração de domínio.
Listar registos DNS de verificação
Obter domínio raiz	Obtenha o domínio raiz de um subdomínio.
Promover	Booliano	Promover um subdomínio verificado no domínio raiz.
Forçar eliminação	Nenhum	Elimine um domínio com uma operação assíncrona.
Verificar	domain	Valide a propriedade do domínio.

Propriedades

Propriedade	Tipo	Descrição
authenticationType	Cadeia de caracteres	Indica o tipo de autenticação configurado para o domínio. O valor é ou `ManagedFederated`. `Managed` indica um domínio gerido na cloud onde o Microsoft Entra ID efetua a autenticação de utilizador. `Federated` indica que a autenticação é federada com um fornecedor de identidade, como o Active Directory no local do inquilino através dos Serviços de Federação do Active Directory. Não anulável. Para atualizar esta propriedade em cenários delegados, a aplicação de chamada tem de ter a permissão Delegada Directory.AccessAsUser.All delegada.
availabilityStatus	Cadeia de caracteres	Esta propriedade é sempre `null` exceto quando a ação de verificação é utilizada. Quando a ação de verificação é utilizada, é devolvida uma entidade de domínio na resposta. A propriedade availabilityStatus da entidade de domínio na resposta é `AvailableImmediately` ou `EmailVerifiedDomainTakeoverScheduled`.
id	Cadeia de caracteres	O nome completamente qualificado do domínio. Chave, imutável, não nulo, exclusivo.
isAdminManaged	Booliano	O valor da propriedade é `false` se a gestão de registos DNS do domínio for delegada ao Microsoft 365. Caso contrário, o valor é `true`. Não anulável.
isDefault	Booliano	`true` para o domínio predefinido que é utilizado para a criação de utilizadores. Existe apenas um domínio predefinido por empresa. Não anulável.
isInitial	Booliano	`true` para o domínio inicial criado pelo Microsoft Online Services. Por exemplo, `contoso.onmicrosoft.com`. Existe apenas um domínio inicial por empresa. Não anulável.
isRoot	Booliano	`true` se o domínio for um domínio de raiz verificado. Caso contrário, `false` se o domínio for um subdomínio ou não verificado. Não anulável.
isVerified	Booliano	`true` para domínios verificados. Não anulável.
passwordNotificationWindowInDays	Int32	Especifica o número de dias antes de um utilizador receber uma notificação de expiração de palavra-passe. 14 dias por predefinição.
passwordValidityPeriodInDays	Int32	Especifica o período de tempo durante o qual uma palavra-passe é válida antes de ter de ser alterada. 90 dias por predefinição.
supportedServices	String collection	As capacidades atribuídas ao domínio. Pode incluir `0`, `1`ou mais dos seguintes valores: `Email`, `Sharepoint`, , `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`,`SharePointDefaultDomainFullRedelegationSharePointPublic` , `OrgIdAuthentication`, , `Yammer`, . `IntuneCustomUrlDomain` Os valores que pode adicionar ou remover com a API incluem: `Email`, `OfficeCommunicationsOnline`, `Yammer`e `CustomUrlDomain`. Não anulável. Para obter mais informações sobre `CustomUrlDomain`o , veja Domínios de URL personalizados em inquilinos externos.
state	domainState	Estado das operações assíncronas agendadas para o domínio.

Relações

As relações entre um domínio e outros objetos no diretório, como os registos de verificação e os registos de configuração do serviço, são expostas através das propriedades de navegação. Pode ler estas relações ao filtrar estas propriedades de navegação nos seus pedidos.

Relação	Tipo	Descrição
domainNameReferences	Coleção directoryObject	Os objetos, como utilizadores e grupos que referenciam o ID de domínio. Só de leitura, Nulo. `$expand` Suporta e `$filter` pelo tipo de objetos OData devolvidos. Por exemplo, `/domains/{domainId}/domainNameReferences/microsoft.graph.user` e `/domains/{domainId}/domainNameReferences/microsoft.graph.group`.
serviceConfigurationRecords	domainDnsRecord collection	O DNS regista os registos que o cliente adiciona ao ficheiro de zona DNS do domínio antes de o domínio poder ser utilizado pelos serviços Do Microsoft Online. Só de leitura, Nulo. Oferece suporte para `$expand`.
verificationDnsRecords	domainDnsRecord collection	O DNS regista que o cliente adiciona ao ficheiro de zona DNS do domínio antes de o cliente poder concluir a verificação da propriedade do domínio com o ID do Microsoft Entra. Só de leitura, Nulo. Oferece suporte para `$expand`.
federationConfiguration	internalDomainFederation	Definições de domínio configuradas pelo cliente quando federadas com o Microsoft Entra ID. Oferece suporte para `$expand`.
rootDomain	domain	Domínio raiz de um subdomínio. Só de leitura, Nulo. Suporta o `$expand`.

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "authenticationType": "String",
  "availabilityStatus": "String",
  "id": "String (identifier)",
  "isAdminManaged": true,
  "isDefault": true,
  "isInitial": true,
  "isRoot": true,
  "isVerified": true,
  "passwordNotificationWindowInDays": 14,
  "passwordValidityPeriodInDays": 90,
  "state": {"@odata.type": "microsoft.graph.domainState"},
  "supportedServices": ["String"]
}

Compartilhar via