tipo de recurso de domínio

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 de versão.

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 os serviços com suporte. As operações de domínio permitem que os registradores automatizem a associação de domínio para serviços como o Microsoft 365. Por exemplo, como parte da inscrição no domínio, um registrador pode habilitar um domínio personalizado para email, sites, autenticação etc.

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

1. Associe 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ínios ou a configuração do servidor DNS.

3. Verifique a propriedade do domínio. Isso verificará o domínio e definirá 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 com suporte recuperando uma lista de registros necessários para habilitar os 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ínios ou a configuração do servidor DNS.

Métodos

Método	Tipo de retorno	Descrição
Obter domínio	domain	Ler propriedades e relações de um objeto de domínio.
Criar domínio	domain	Adiciona um domínio ao inquilino.
Listar domínio	domain	Recupere todos os domínios vinculados ao locatário.
Listar domainNameReference	Coleção directoryObject	Recupere uma lista de objetos de diretório com uma referência ao domínio.
Listar serviceConfigurationRecords	coleção domainDnsRecord	Recupere uma lista de registros DNS de domínio para configuração de domínio.
Listar verificationDnsRecords	coleção domainDnsRecord	Recupere uma lista de registros DNS de domínio para verificação de domínio.
Atualizar domínio	domain	Atualiza um domínio.
Excluir domínio	Nenhum	Exclui um domínio.
Domínio ForceDelete	Nenhum	Exclui um domínio usando uma operação assíncrona.
Verificar domínio	domain	Valida a propriedade do domínio.
Promover domínio	Booleano	Promover um subdomínio verificado para o domínio raiz.

Propriedades

Propriedade	Tipo	Descrição
Authenticationtype	Cadeia de caracteres	Indica o tipo de autenticação configurado para o domínio. O valor é ou Managed Federated. Managed indica um domínio gerenciado na nuvem em que o Azure AD executa a autenticação do usuário. Federated indica 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. Essa propriedade é somente leitura e não permite valor nulo.
availabilityStatus	Cadeia de caracteres	Essa propriedade é sempre exceto null 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 AvailableImmediately EmailVerifiedDomainTakeoverScheduled.
id	Cadeia de caracteres	O nome totalmente qualificado do domínio. Chave, imutável, não anulável, exclusiva.
isAdminManaged	Booleano	O valor da propriedade será se false o gerenciamento de registros DNS do domínio tiver sido delegado ao 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 (companyname.onmicrosoft.com). Há apenas um domínio inicial por empresa. Não anulável
isRoot	Booleano	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	Booleano	true se o domínio tiver concluído 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 uma notificação de que sua senha expirará. Se a propriedade não estiver definida, um valor padrão de 14 dias será usado.
passwordValidityPeriodInDays	Int32	Especifica o período de tempo em que uma senha é válida antes de ser alterada. Se a propriedade não estiver definida, um valor padrão de 90 dias será usado.
supportedServices	Coleção de cadeias de caracteres	Os recursos atribuídos ao domínio. Pode incluir 0ou 1 mais dos seguintes valores: Email, Sharepoint, , EmailInternalRelayOnly, OfficeCommunicationsOnline,SharePointDefaultDomain , FullRedelegation, SharePointPublic, OrgIdAuthentication, , Yammer, . Intune Os valores que você pode adicionar/remover usando a API do Graph incluem: Email, OfficeCommunicationsOnline, Yammer. Não anulável.
estado	domainState	Status de 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 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. Dá $expand suporte e $filter pelo tipo OData de objetos retornados. Por exemplo e /domains/{domainId}/domainNameReferences/microsoft.graph.user /domains/{domainId}/domainNameReferences/microsoft.graph.group.
serviceConfigurationRecords	coleção domainDnsRecord	Registros DNS que o cliente adiciona ao arquivo de zona DNS do domínio antes que o domínio possa ser usado pelos serviços Online da Microsoft. Somente leitura, anulável. Suporta o $expand.
verificationDnsRecords	coleção 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 Azure AD. Somente leitura, anulável. Suporta o $expand.
federationConfiguration	internalDomainFederation	Configurações de domínio definidas pelo cliente quando federadas com o Azure AD. Suporta o $expand.

Representação JSON

Veja a seguir uma representação JSON do 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"]
}