tipo de recurso de domínio

Artigo
10/21/2023

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 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. 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 de domínio, um registrador pode habilitar um domínio de vaidade para email, sites, autenticação etc.

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

Associe um domínio a um locatário.
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.
Verifique a propriedade do domínio. Isso verificará o domínio e definirá a propriedade isVerified como true.
Indique os serviços com suporte que você planeja usar com o domínio.
Configure 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ínio ou a configuração do servidor DNS.

Métodos

Método	Tipo de retorno	Descrição
Obter domínio	domain	Leia propriedades e relações de um objeto de domínio.
Criar domínio	domain	Adiciona um domínio ao inquilino.
Domínio list	domain	Recupere todos os domínios vinculados ao locatário.
List 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.
Verificação de listaDnsRecords	coleção domainDnsRecord	Recupere uma lista de registros DNS de domínio para verificação de domínio.
Atualizar domínio	domain	Atualizações 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	Booliano	Promover um subdomínio verificado no 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 é `Managed` ou `Federated`. `Managed`indica um domínio gerenciado por nuvem em que Microsoft Entra ID 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 de Serviços de Federação do Active Directory (AD FS). Não anulável.
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 é `AvailableImmediately` ou `EmailVerifiedDomainTakeoverScheduled`.
id	Cadeia de caracteres	O nome totalmente qualificado do domínio. Chave, imutável, não nula, exclusiva.
isAdminManaged	Booliano	O valor da propriedade será `false` se o gerenciamento de registros DNS do domínio tiver sido delegado ao Microsoft 365. Caso contrário, o valor é `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 pelos Serviços Online da Microsoft (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 tiver concluído a verificação de propriedade do domínio. Não anulável
passwordNotificationWindowInDays	Int32	Especifica o número de dias antes de um usuário receber a 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 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	String collection	Os recursos atribuídos ao domínio. Pode incluir `0`, `1` ou mais dos seguintes valores: `Email`, , `Sharepoint`, `EmailInternalRelayOnly`,`SharePointDefaultDomainOfficeCommunicationsOnline` , , `SharePointPublicFullRedelegation`, , `OrgIdAuthentication`, `Yammer`, . `Intune` Os valores que você pode adicionar/remover usando API do Graph incluem: `Email`, , `OfficeCommunicationsOnlineYammer`. Não anulável.
state	domainState	Status 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 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 do domínio. Somente leitura, Nullable. `$expand` Dá suporte e `$filter` pelo tipo OData de objetos retornados. Por exemplo `/domains/{domainId}/domainNameReferences/microsoft.graph.user` , e `/domains/{domainId}/domainNameReferences/microsoft.graph.group`.
serviceConfigurationRecords	coleção domainDnsRecord	O DNS registra que o cliente adiciona ao arquivo de zona DNS do domínio antes que o domínio possa ser usado pelos serviços do Microsoft Online. Somente leitura, Nullable. Oferece suporte para `$expand`.
verificationDnsRecords	coleção domainDnsRecord	O DNS registra 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 Microsoft Entra ID. Somente leitura, Nullable. Oferece suporte para `$expand`.
federationConfiguration	internalDomainFederation	Configurações de domínio configuradas pelo cliente quando federadas com Microsoft Entra ID. Suporta o `$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"]
}