Server Azure AD Administrators - List By Server

Serviço:

SQL Database

Versão da API:

2021-11-01

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	AdministratorListResult	Recuperamos 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 - O recurso ou as propriedades de recurso no corpo da solicitação são vazios ou inválidos. 400 InvalidServerAzureADOnlyAuthenticationParameter - O usuário tentou definir o parâmetro AzureADOnlyAuthentication como false, o que não é permitido, use a API azureADOnlyAuthentications. 400 InvalidServerAzureADAdminDeleteOperation - O usuário tentou excluir o administrador do Azure Active Azure do servidor quando AzureADOnlyAuthentication estiver definido, use a API azureADOnlyAuthentications primeiro. 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 ResourceNotFound - O recurso solicitado não foi encontrado.

Exemplos

Gets a list of Azure Active Directory administrator.

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

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

AdministratorListResult

Uma lista de administradores do Active Directory.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	ServerAzureADAdministrator[]	Matriz de resultados.

AdministratorType

Tipo do administrador do servidor.

Nome	Tipo	Description
ActiveDirectory	string

ServerAzureADAdministrator

Administrador do Azure Active Directory.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.administratorType	AdministratorType	Tipo do administrador do servidor.
properties.azureADOnlyAuthentication	boolean	Somente a Autenticação do Azure Active Directory está habilitada.
properties.login	string	Nome de logon do administrador do servidor.
properties.sid	string	SID (ID de objeto) do administrador do servidor.
properties.tenantId	string	ID do locatário do administrador.
type	string	Tipo de recurso.