Server Azure AD Administrators - Create Or Update

Usługa:: SQL Database

Wersja interfejsu API:: 2025-01-01

Tworzy lub aktualizuje istniejącego administratora Azure Active Directory.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
administratorName	path	True	AdministratorName	Nazwa administratora usługi Active Directory serwera.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.login	True	string	Nazwa logowania administratora serwera.
properties.sid	True	string (uuid)	Identyfikator SID (identyfikator obiektu) administratora serwera.
properties.administratorType		AdministratorType	Typ administratora serwera.
properties.tenantId		string (uuid)	Identyfikator dzierżawy administratora.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ServerAzureADAdministrator	Operacja aktualizacji zasobu 'ServerAzureADAdministrator' zakończyła się sukcesem
201 Created	ServerAzureADAdministrator	Resource 'ServerAzureADAdministrator' operacja tworzenia zakończyła się sukcesem Nagłówki Location: string Retry-After: integer
202 Accepted		Zaakceptowano operację zasobu. Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Creates or updates an existing Azure Active Directory administrator.

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

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"
  }
}

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/SQL/stable/2025-01-01/examples/AdministratorCreateOrUpdate.json
// this example is just showing the usage of "ServerAzureADAdministrators_CreateOrUpdate" 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
SqlAdministratorName administratorName = SqlAdministratorName.ActiveDirectory;
SqlServerAzureADAdministratorData data = new SqlServerAzureADAdministratorData
{
    AdministratorType = SqlAdministratorType.ActiveDirectory,
    Login = "bob@contoso.com",
    Sid = Guid.Parse("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
    TenantId = Guid.Parse("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
};
ArmOperation<SqlServerAzureADAdministratorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, administratorName, data);
SqlServerAzureADAdministratorResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Kod stanu:: 201

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

Kod stanu:: 202

Definicje

Nazwa	Opis
AdministratorName
AdministratorType	Typ administratora serwera.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ServerAzureADAdministrator	Azure Active Directory administrator.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AdministratorName

Wyliczenie

Wartość	Opis
ActiveDirectory	Usługa ActiveDirectory

AdministratorType

Wyliczenie

Typ administratora serwera.

Wartość	Opis
ActiveDirectory	Usługa ActiveDirectory

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Błąd dodatkowe informacje.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ServerAzureADAdministrator

Objekt

Azure Active Directory administrator.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.administratorType	AdministratorType	Typ administratora serwera.
properties.azureADOnlyAuthentication	boolean	Azure Active Directory tylko uwierzytelnianie włączone.
properties.login	string	Nazwa logowania administratora serwera.
properties.sid	string (uuid)	Identyfikator SID (identyfikator obiektu) administratora serwera.
properties.tenantId	string (uuid)	Identyfikator dzierżawy administratora.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.