Obtener dominio

Espacio de nombres: microsoft.graph

Recupere las propiedades y las relaciones del objeto de dominio.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Domain.Read.All	Domain.ReadWrite.All, Directory.Read.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Domain.Read.All	Domain.ReadWrite.All, Directory.Read.All

Importante

En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Se admiten los siguientes roles con privilegios mínimos para esta operación.

• Administrador de usuarios
• Administrador del servicio de asistencia
• Administrador de soporte técnico de servicio
• Administrador de facturación
• Administrador de buzones
• Lectores de directorio
• Escritores de directorios
• Administrador de licencias de AdHoc
• Administrador de la aplicación
• Lector de seguridad
• Administrador de seguridad
• Administrador de roles con privilegios
• Administrador de aplicaciones en la nube
• Aprobador de acceso de caja de seguridad del cliente
• Administrador de Dynamics 365
• Administrador de Power BI
• Administrador de Azure Information Protection
• Administrador de Análisis de escritorio
• Administrador de licencias
• Administrador de Escritorio administrado de Microsoft
• Administrador de autenticación con privilegios
• Administrador de comunicaciones de Teams
• Ingeniero de soporte en comunicaciones de Teams
• Administrador de autenticación
• Especialista de soporte en comunicaciones de Teams
• Administrador de Teams
• Administrador de Insights
• Administrador de datos de cumplimiento
• Operador de seguridad
• Administrador de Kaizala
• Lector global
• Usuario del Centro de negocios de licencias por volumen
• Usuario del Centro de servicios de licencias por volumen
• Administrador de comercio moderno
• Microsoft Store para Empresas usuario
• Revisor de directorios
• Administrador de nombres de dominio
• Usuarios
• Usuario invitado
• Usuario invitado restringido

Solicitud HTTP

GET /domains/{id}

En {id}, especifique el dominio con su nombre completo.

Parámetros de consulta opcionales

Este método admite los parámetros de consulta de OData a modo de ayuda para personalizar la respuesta.

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta y un 200 OK objeto de dominio en el cuerpo de la respuesta.

Ejemplo

Solicitud

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 obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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 obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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 obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDomain -DomainId $domainId

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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 obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

Nota: el objeto de respuesta que se muestra aquí puede haberse acortado para mejorar la legibilidad.

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
}