Server Azure AD Administrators - List By Server

Service:

SQL Database

API Version:

2021-11-01

Obtém uma lista de administradores do Azure Active Directory num servidor.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Respostas

Name	Tipo	Description
200 OK	AdministratorListResult	Foi obtida com êxito a lista de administradores do Azure Active Directory.
Other Status Codes		Respostas de Erro: *** 400 InvalidServerAdministratorTypePropertyName – o tipo de administrador do Active Directory do servidor deve ser ActiveDirectory 400 InvalidResourceRequestBody – as propriedades do recurso ou recurso no corpo do pedido estão vazias ou são inválidas. 400 InvalidServerAzureADOnlyAuthenticationParameter – o utilizador tentou definir o parâmetro AzureADOnlyAuthentication como falso, o que não é permitido. Em alternativa, utilize a API azureADOnlyAuthentications. 400 InvalidServerAzureADAdminDeleteOperation – o utilizador tentou eliminar o administrador do Azure Active Azure do servidor quando a AzureADOnlyAuthentication está definida. Utilize primeiro a API azureADOnlyAuthentications. 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na subscrição especificados. 404 ResourceNotFound – o recurso pedido não foi encontrado.

Exemplos

Gets a list of Azure Active Directory administrator.

Sample Request

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

import com.azure.core.util.Context;

/** 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", 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

Sample Response

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
      }
    }
  ]
}

Definições

Name	Description
AdministratorListResult	Uma lista de administradores do Active Directory.
AdministratorType	Tipo de administrador de gravidade.
ServerAzureADAdministrator	Administrador do Azure Active Directory.

AdministratorListResult

Uma lista de administradores do Active Directory.

Name	Tipo	Description
nextLink	string	Ligação para obter a página seguinte dos resultados.
value	ServerAzureADAdministrator[]	Matriz de resultados.

AdministratorType

Tipo de administrador de gravidade.

Name	Tipo	Description
ActiveDirectory	string

ServerAzureADAdministrator

Administrador do Azure Active Directory.

Name	Tipo	Description
id	string	ID do Recurso.
name	string	Nome do recurso.
properties.administratorType	AdministratorType	Tipo de administrador de gravidade.
properties.azureADOnlyAuthentication	boolean	Apenas a Autenticação do Azure Active Directory está ativada.
properties.login	string	Nome de início de sessão do administrador do servidor.
properties.sid	string	SID (ID de objeto) do administrador do servidor.
properties.tenantId	string	ID do inquilino do administrador.
type	string	Tipo de recurso.