Obter domínio

Namespace: microsoft.graph

Obtenha as propriedades e relações do objeto de domínio.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	Domain.Read.All	Domain.ReadWrite.All, Directory.Read.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	Domain.Read.All	Domain.ReadWrite.All, Directory.Read.All

Importante

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

• Administrador do usuário
• Administrador da Assistência Técnica
• Administrador do Suporte de Serviços
• Administrador de Cobrança
• Administrador de caixa de correio
• Leitores de Diretórios
• Escritores de diretório
• Administrador de Licenças do AdHoc
• Administrador de Aplicativos
• Leitor de segurança
• Administrador de Segurança
• Administrador de Função Privilegiada
• Administrador de Aplicativos de Nuvem
• Aprovador de Acesso do Sistema de Proteção de Dados do Cliente
• Administrador do Dynamics 365
• Administrador do Power BI
• Administrador Proteção de Informações do Azure
• Administrador do Análise de Área de Trabalho
• Administrador de Licenças
• Administrador de Ambiente de Trabalho Gerido da Microsoft
• Administrador de Autenticação Privilegiada
• Administrador de Comunicações do Teams
• Engenheiro de Suporte de Comunicações de Equipes
• Administrador de Autenticação
• Especialista em suporte à comunicação de equipes
• Administrador do Teams
• Insights do Administrador
• Administrador de Dados de Conformidade
• Operador de Segurança
• Administrador do Kaizala
• Leitor Global
• Utilizador do Centro de Empresas de Licenciamento em Volume
• Utilizador do Centro de Serviços de Licenciamento em Volume
• Administrador de Comércio Moderno
• Utilizador Microsoft Store para Empresas
• Revisor de Diretórios
• Administrador de Nomes de Domínio
• Usuários
• Utilizador Convidado
• Utilizador Convidado Restrito

Solicitação HTTP

GET /domains/{id}

Para {id}, especifique o domínio com seu nome de domínio totalmente qualificado.

Parâmetros de consulta opcionais

Este método dá suporte a Parâmetros de consulta OData para ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto de domínio no corpo da resposta.

Exemplo

Solicitação

HTTP

GET https://graph.microsoft.com/v1.0/domains/contoso.com

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Domains["{domain-id}"].GetAsync();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

mgc domains get --domain-id {domain-id}

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
domains, err := graphClient.Domains().ByDomainId("domain-id").Get(context.Background(), nil)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Domain result = graphClient.domains().byDomainId("{domain-id}").get();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let domain = await client.api('/domains/contoso.com')
	.get();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->domains()->byDomainId('domain-id')->get()->wait();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDomain -DomainId $domainId

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.domains.by_domain_id('domain-id').get()

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

Observação: o objeto de resposta exibido aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#domains/$entity",
    "authenticationType": "Managed",
    "availabilityStatus": null,
    "id": "contoso.com",
    "isAdminManaged": true,
    "isDefault": true,
    "isInitial": true,
    "isRoot": true,
    "isVerified": true,
    "supportedServices": [
        "Email",
        "OfficeCommunicationsOnline"
    ],
    "passwordValidityPeriodInDays": null,
    "passwordNotificationWindowInDays": null,
    "state": null
}