tipo de recurso de domínio

Namespace: microsoft.graph

Representa um domínio associado ao locatário.

Use operações de domínio para associar domínios a um locatário, verificar a propriedade do domínio e configurar serviços com suporte. A verificação de um domínio por meio do Microsoft Graph não configura o domínio para uso com os serviços do Office 365, como o Exchange. A configuração completa do domínio para funcionar com produtos do Microsoft 365 pode exigir etapas adicionais. Para obter mais informações, consulte Configuração do administrador do Microsoft 365.

Para associar um domínio a um locatário:

  1. Associar um domínio a um locatário.

  2. Recupere os registros de verificação de domínio. Adicione os detalhes do registro de verificação ao arquivo de zona do domínio usando o registrador de domínio ou a configuração do servidor DNS.

  3. Verifique a propriedade do domínio, incluindo a execução de assumir o controle do administrador externo. Essa operação define a propriedade isVerified como true.

  4. Indique os serviços com suporte que você planeja usar com o domínio.

  5. Configure os serviços suportados recuperando uma lista de registros necessários para habilitar serviços para o domínio. Adicione os detalhes do registro de configuração ao arquivo de zona do domínio usando o registrador de domínio ou a configuração do servidor DNS.

Métodos

Método Tipo de retorno Descrição
List domain Recupere todos os domínios vinculados ao locatário.
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 Exclui um domínio.
Forçar a exclusão Nenhum Exclui um domínio usando 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 nome de domínio Coleção directoryObject Recupere uma lista de objetos de diretório com uma referência ao domínio.
Listar registros de configuração de serviço Coleta domainDnsRecord Recupere uma lista de registros DNS de domínio para configuração de domínio.
Verificação de lista de registros DNS Coleta domainDnsRecord Recupere uma lista de registros 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 gerenciado na nuvem no qual o Microsoft Entra ID realiza a autenticação do usuário. Federatedindica que a autenticação é federada com um provedor de identidade, como o Active Directory local do locatário por meio dos Serviços de Federação do Active Directory). Não anulável.

Para atualizar essa propriedade em cenários delegados, o aplicativo de chamada deve receber a permissão Domain-InternalFederation.ReadWrite.All .
availabilityStatus Cadeia de caracteres Essa propriedade é sempre null exceto quando a ação de verificação é usada. Quando a ação de verificação é usada, uma entidade de domínio é retornada na resposta. A propriedade availabilityStatus da entidade de domínio na resposta é ou AvailableImmediatelyEmailVerifiedDomainTakeoverScheduled.
id Cadeia de caracteres O nome totalmente qualificado do domínio. Chave, imutável, não anulável, exclusiva.
isAdminManaged Booliano O valor da propriedade é false se o gerenciamento de registro DNS do domínio é delegado para Microsoft 365. Caso contrário, o valor será true. Não anulável
isDefault Booliano true se esse for o domínio padrão usado para a criação do usuário. Há apenas um domínio padrão por empresa. Não anulável.
isInitial Booliano true se esse for o domínio inicial criado pelo Microsoft Online Services (contoso.com). Há apenas um domínio inicial por empresa. Não anulável
isRoot Booliano true se o domínio for um domínio 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 concluiu a verificação de propriedade do domínio. Não anulável.
passwordNotificationWindowInDays Int32 Especifica o número de dias antes que um usuário receba a notificação de que sua senha expira. Se a propriedade não for definida, será utilizado um valor padrão de 14 dias.
passwordValidityPeriodInDays Int32 Especifica o período de tempo que uma senha é válida antes de ser alterada. Se a propriedade não for definida, será usado um valor padrão de 90 dias.
state domainState Status das operações assíncronas agendadas para o domínio.
supportedServices String collection Os recursos atribuídos ao domínio. Pode incluir 0ou mais dos seguintes valores: Email, Sharepoint, EmailInternalRelayOnly, YammerOfficeCommunicationsOnlineSharePointDefaultDomainOrgIdAuthenticationFullRedelegationSharePointPublic. Intune1 Os valores que você pode adicionar ou remover usando 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 seus registros de verificação e registros de configuração de serviço, são expostas por meio de propriedades de navegação. Você pode ler essas relações direcionando essas propriedades de navegação em suas solicitações.

Relação Tipo Descrição
domainNameReferences Coleção directoryObject Os objetos, como usuários e grupos, que fazem referência à ID de domínio. Somente leitura, anulável. Não dá suporte a $expand. Suporta $filter pelo tipo de objetos OData retornados. Por exemplo, /domains/{domainId}/domainNameReferences/microsoft.graph.user e /domains/{domainId}/domainNameReferences/microsoft.graph.group.
federationConfiguration internalDomainFederation Configurações de domínio definidas por um cliente quando federado com o Microsoft Entra ID. Não dá suporte a $expand.
rootDomain domain Domínio raiz de um subdomínio. Somente leitura, anulável. Oferece suporte para $expand.
serviceConfigurationRecords Coleta domainDnsRecord Registros DNS que o cliente adiciona ao arquivo de zona DNS do domínio antes que o domínio possa ser usado pelo Microsoft Online Services. Somente leitura, anulável. Não dá suporte a $expand.
verificationDnsRecords Coleta domainDnsRecord Registros DNS que o cliente adiciona ao arquivo de zona DNS do domínio antes que o cliente possa concluir a verificação de propriedade do domínio com o Microsoft Entra ID. Somente leitura, anulável. Não dá suporte a $expand.

Representação JSON

A representação JSON a seguir 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"]
}
  • Last updated on