tipo de recurso de domínio

  • Artigo

Namespace: microsoft.graph

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. Verificar um domínio através do Microsoft Graph não configura o domínio para utilização com serviços Office 365 como o Exchange. A configuração total do domínio para trabalhar com produtos do Microsoft 365 pode exigir passos adicionais. Para obter mais informações, consulte Configuração de administrador do Microsoft 365.

Para associar um domínio a um inquilino:

  1. Associar um domínio a um inquilino.

  2. 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 da entidade de registo de domínios ou do servidor DNS.

  3. Verifique a propriedade do domínio. Esta ação verifica o domínio e define a propriedade isVerified comotrue.

  4. Indique os serviços suportados que planeia utilizar com o domínio.

  5. 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 Adiciona um domínio ao inquilino.
Get domain Ler propriedades e relações de um objeto de domínio.
Obter domínio raiz domain Obtenha o domínio raiz de um subdomínio.
Atualizar domain Atualizações um domínio.
Delete Nenhum Elimina um domínio.
Forçar eliminação Nenhum Elimina um domínio com uma operação assíncrona.
Verificar domain Valida a propriedade do domínio.
Promover Booliano Promover um subdomínio verificado no domínio raiz.
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.

Propriedades

Propriedade Tipo Descrição
authenticationType Cadeia de caracteres Indica o tipo de autenticação configurado para o domínio. O valor é ou ManagedFederated. Managedindica um domínio gerido na cloud onde Microsoft Entra ID efetua a autenticação de utilizador. Federatedindica que a autenticação é federada com um fornecedor de identidade, como o Active Directory local do inquilino através de Serviços de Federação do Active Directory (AD FS). 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 se este for o domínio predefinido utilizado para a criação do utilizador. Existe apenas um domínio predefinido por empresa. Não anulável.
isInitial Booliano true se este for o domínio inicial criado pelo Microsoft Online Services (contoso.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 se o domínio tiver concluído a verificação da propriedade do domínio. Não anulável.
passwordNotificationWindowInDays Int32 Especifica o número de dias antes de um utilizador receber a notificação de que a palavra-passe expira. Se a propriedade não estiver definida, é utilizado um valor predefinido de 14 dias.
passwordValidityPeriodInDays Int32 Especifica o período de tempo durante o qual uma palavra-passe é válida antes de ter de ser alterada. Se a propriedade não estiver definida, é utilizado um valor predefinido de 90 dias.
state domainState Estado das operações assíncronas agendadas para o domínio.
supportedServices String collection As capacidades atribuídas ao domínio. Pode incluir 0, 1 ou mais dos seguintes valores: Email, , Sharepoint, EmailInternalRelayOnly, SharePointDefaultDomainOfficeCommunicationsOnline, , FullRedelegation, SharePointPublic, OrgIdAuthentication, , YammerIntune. Os valores que pode adicionar ou remover com a API incluem: Email, OfficeCommunicationsOnline, Yammer. Não anulável.

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. Não suporta $expand. $filter Suporta o tipo de objetos OData devolvidos. Por exemplo, /domains/{domainId}/domainNameReferences/microsoft.graph.user e /domains/{domainId}/domainNameReferences/microsoft.graph.group.
federationConfiguration internalDomainFederation Definições de domínio configuradas por um cliente quando federados com Microsoft Entra ID. Não suporta $expand.
rootDomain domain Domínio raiz de um subdomínio. Só de leitura, Nulo. Oferece suporte para $expand.
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. Não suporta $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 Microsoft Entra ID. Só de leitura, Nulo. Não suporta $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"]
}