Server Azure AD Administrators - List By Server

Serviço:: SQL Database

Versão da API:: 2023-08-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/administrators?api-version=2023-08-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. Você pode obter esse valor da API do Azure Resource Manager ou 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

Name	Tipo	Description
200 OK	AdministratorListResult	Recuperada com êxito a lista de administradores do Azure Ative Directory.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial 400 InvalidServerAdministratorTypePropertyName - O tipo de administrador do Ative Directory do servidor deve ser ActiveDirectory 400 InvalidResourceRequestBody - As propriedades do recurso ou do recurso no corpo da solicitação estão vazias ou são inválidas. 400 InvalidServerAzureADOnlyAuthenticationParameter - O usuário tentou definir o parâmetro AzureADOnlyAuthentication como false que não é permitido, use azureADOnlyAuthentications API em vez disso. 400 InvalidServerAzureADAdminDeleteOperation - O usuário tentou excluir o servidor Azure Ative Azure admin quando AzureADOnlyAuthentication está definido, use azureADOnlyAuthentications API primeiro. 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 ResourceNotFound - O recurso solicitado não foi encontrado.

Name

Tipo

Description

200 OK

AdministratorListResult

Recuperada com êxito a lista de administradores do Azure Ative Directory.

Other Status Codes

ErrorResponse

Respostas de erro: ***

400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada
400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial
400 InvalidServerAdministratorTypePropertyName - O tipo de administrador do Ative Directory do servidor deve ser ActiveDirectory
400 InvalidResourceRequestBody - As propriedades do recurso ou do recurso no corpo da solicitação estão vazias ou são inválidas.
400 InvalidServerAzureADOnlyAuthenticationParameter - O usuário tentou definir o parâmetro AzureADOnlyAuthentication como false que não é permitido, use azureADOnlyAuthentications API em vez disso.
400 InvalidServerAzureADAdminDeleteOperation - O usuário tentou excluir o servidor Azure Ative Azure admin quando AzureADOnlyAuthentication está definido, use azureADOnlyAuthentications API primeiro.
404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados.
404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado
404 ResourceNotFound - O recurso solicitado não foi encontrado.

Exemplos

Gets a list of Azure Active Directory administrator.

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/AdministratorList.json
// this example is just showing the usage of "ServerAzureADAdministrators_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-4799";
string serverName = "sqlcrudtest-6440";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerAzureADAdministratorResource
SqlServerAzureADAdministratorCollection collection = sqlServer.GetSqlServerAzureADAdministrators();

// invoke the operation and iterate over the result
await foreach (SqlServerAzureADAdministratorResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlServerAzureADAdministratorData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Resposta da amostra

Código de estado:: 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 Ative Directory.
AdministratorType	Tipo de administrador de corte.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ServerAzureADAdministrator	Administrador do Azure Ative Directory.

AdministratorListResult

Object

Uma lista de administradores do Ative Directory.

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

AdministratorType

Enumeração

Tipo de administrador de corte.

Valor	Description
ActiveDirectory

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.