Server Azure AD Administrators - List By Server

Servicio:

SQL Database

Versión de la API:

2021-11-01

Obtiene una lista de administradores de Azure Active Directory en un servidor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/administrators?api-version=2021-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	AdministratorListResult	Recuperó correctamente la lista de administradores de Azure Active Directory.
Other Status Codes		Respuestas de error: *** 400 InvalidServerAdministratorTypePropertyName: el tipo de administrador de Active Directory del servidor debe ser ActiveDirectory 400 InvalidResourceRequestBody: las propiedades de recurso o recurso del cuerpo de la solicitud están vacías o no son válidas. 400 InvalidServerAzureADOnlyAuthenticationParameter: el usuario intentó establecer el parámetro AzureADOnlyAuthentication en false, que no está permitido, use azureADOnlyAuthentications API en su lugar. 400 InvalidServerAzureADAdminDeleteOperation: el usuario intentó eliminar el administrador de Azure Active Azure del servidor cuando se establece AzureADOnlyAuthentication, use primero la API azureADOnlyAuthentications. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 ResourceNotFound: no se encontró el recurso solicitado.

Ejemplos

Gets a list of Azure Active Directory administrator.

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators?api-version=2021-11-01

Java

/**
 * Samples for ServerAzureADAdministrators ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/AdministratorList.json
     */
    /**
     * Sample code: Gets a list of Azure Active Directory administrator.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getsAListOfAzureActiveDirectoryAdministrator(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAzureADAdministrators().listByServer("sqlcrudtest-4799",
            "sqlcrudtest-6440", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators/ActiveDirectory",
      "name": "ActiveDirectory",
      "type": "Microsoft.Sql/servers/administrators",
      "properties": {
        "administratorType": "ActiveDirectory",
        "login": "bob@contoso.com",
        "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        "azureADOnlyAuthentication": true
      }
    }
  ]
}

Definiciones

Nombre	Description
AdministratorListResult	Una lista de administradores de Active Directory.
AdministratorType	Tipo del administrador del servidor.
ServerAzureADAdministrator	Administrador de Azure Active Directory.

AdministratorListResult

Una lista de administradores de Active Directory.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	ServerAzureADAdministrator[]	Matriz de resultados.

AdministratorType

Tipo del administrador del servidor.

Nombre	Tipo	Description
ActiveDirectory	string

ServerAzureADAdministrator

Administrador de Azure Active Directory.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.administratorType	AdministratorType	Tipo del administrador del servidor.
properties.azureADOnlyAuthentication	boolean	Autenticación solo de Azure Active Directory habilitada.
properties.login	string	Nombre de inicio de sesión del administrador del servidor.
properties.sid	string	SID (id. de objeto) del administrador del servidor.
properties.tenantId	string	Id. de inquilino del administrador.
type	string	Tipo de recurso.