Server Azure AD Administrators - List By Server

Služba:

SQL Database

Verze rozhraní API:

2023-08-01

Získá seznam správců Azure Active Directory na serveru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	AdministratorListResult	Seznam správců Azure Active Directory se úspěšně načetl.
Other Status Codes	ErrorResponse	Chybové odpovědi: *** 400 ManagedInstanceStoppingOrStopped – Konfliktní operace odeslaná, když je instance v zastaveném nebo zastaveném stavu 400 ManagedInstanceStarting – Konfliktní operace odeslaná při spuštění instance 400 InvalidServerAdministratorTypePropertyName – Typ správce služby Active Directory serveru by měl být ActiveDirectory 400 InvalidResourceRequestBody – vlastnost prostředku nebo prostředku v textu požadavku je prázdná nebo neplatná. 400 InvalidServerAzureADOnlyAuthenticationParameter – Uživatel se pokusil nastavit parametr AzureADOnlyAuthentication na hodnotu false, což není povoleno, použijte místo toho rozhraní API azureADOnlyAuthentications. 400 InvalidServerAzureADAdminDeleteOperation – Uživatel se pokusil odstranit správce Azure Active Azure serveru při nastavení AzureADOnlyAuthentication, nejprve použijte rozhraní API azureADOnlyAuthentications. 404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném. 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 ResourceNotFound – Požadovaný prostředek nebyl nalezen.

Příklady

Gets a list of Azure Active Directory administrator.

Ukázkový požadavek

HTTP

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

dotnet

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://learn.microsoft.com/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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AdministratorListResult	Seznam správců služby Active Directory
AdministratorType	Typ správce serveru.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ServerAzureADAdministrator	Správce Azure Active Directory.

AdministratorListResult

Objekt

Seznam správců služby Active Directory

Name	Typ	Description
nextLink	string	Odkaz na načtení další stránky výsledků
value	ServerAzureADAdministrator[]	Pole výsledků

AdministratorType

Výčet

Typ správce serveru.

Hodnota	Description
ActiveDirectory

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ServerAzureADAdministrator

Objekt

Správce Azure Active Directory.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.administratorType	AdministratorType	Typ správce serveru.
properties.azureADOnlyAuthentication	boolean	Je povoleno pouze ověřování Azure Active Directory.
properties.login	string	Přihlašovací jméno správce serveru.
properties.sid	string (uuid)	IDENTIFIKÁTOR SID (ID objektu) správce serveru.
properties.tenantId	string (uuid)	ID tenanta správce.
type	string	Typ prostředku.