Server Azure AD Administrators - Create Or Update

Usługa:

SQL Database

Wersja interfejsu API:

2023-08-01

Tworzy lub aktualizuje istniejącego administratora usługi Azure Active Directory.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
administratorName	path	True	AdministratorName	Nazwa administratora usługi Active Directory serwera.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

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	Pomyślnie zaktualizowano administratora usługi Azure Active Directory.
201 Created	ServerAzureADAdministrator	Pomyślnie utworzono administratora usługi Azure Active Directory.
202 Accepted		Akceptowane Nagłówki Location: string
Other Status Codes	ErrorResponse	Odpowiedzi na błędy: *** 400 ManagedInstanceStoppingOrStopped — operacja powodująca konflikt przesłana, gdy wystąpienie jest w stanie zatrzymania/zatrzymania 400 ManagedInstanceStarting — operacja powodująca konflikt przesłana, gdy wystąpienie jest w stanie początkowym 400 InvalidServerAdministratorTypePropertyName — typ administratora usługi Active Directory serwera powinien mieć wartość ActiveDirectory 400 InvalidResourceRequestBody — właściwości zasobu lub zasobu w treści żądania są puste lub nieprawidłowe. 400 InvalidServerAzureADOnlyAuthenticationParameter — użytkownik próbował ustawić parametr AzureADOnlyAuthentication na wartość false, która nie jest dozwolona, zamiast tego użyj interfejsu API azureADOnlyAuthentications. 400 InvalidServerAzureADAdminDeleteOperation — użytkownik próbował usunąć administratora usługi Azure Active Azure serwera po ustawieniu usługi AzureADOnlyAuthentication, najpierw użyj interfejsu API azureADOnlyAuthentications. 400 ServerAdministratorNameAlreadyExists — użytkownik próbował ustawić administratora zewnętrznego, a główna nazwa już istnieje w bazie danych master. 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji. 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje. 409 CannotCancelOperation — operacja zarządzania jest w stanie, którego nie można anulować. 409 OperationCancelled — operacja została anulowana przez użytkownika. 409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie. 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby. 500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji. 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

Przykłady

Creates or updates an existing Azure Active Directory administrator.

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "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
  }
}

Kod stanu:

201

{
  "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
  }
}

Kod stanu:

202

Definicje

Nazwa	Opis
AdministratorName	Nazwa administratora usługi Active Directory serwera.
AdministratorType	Typ administratora serwera.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ServerAzureADAdministrator	Administrator usługi Azure Active Directory.

AdministratorName

Wyliczanie

Nazwa administratora usługi Active Directory serwera.

Wartość	Opis
ActiveDirectory

AdministratorType

Wyliczanie

Typ administratora serwera.

Wartość	Opis
ActiveDirectory

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[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ServerAzureADAdministrator

Objekt

Administrator usługi Azure Active Directory.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.administratorType	AdministratorType	Typ administratora serwera.
properties.azureADOnlyAuthentication	boolean	Włączono tylko uwierzytelnianie usługi Azure Active Directory.
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.
type	string	Typ zasobu.