Server Azure AD Administrators - Create Or Update

Dienst:: SQL Database

API-Version:: 2023-08-01

Erstellt oder aktualisiert einen vorhandenen Azure Active Directory-Administrator.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
administratorName	path	True	AdministratorName	Der Name des Server-Active Directory-Administrators.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.login	True	string	Anmeldename des Serveradministrators.
properties.sid	True	string (uuid)	SID (Objekt-ID) des Serveradministrators.
properties.administratorType		AdministratorType	Typ des Serveradministrators.
properties.tenantId		string (uuid)	Mandanten-ID des Administrators.

Antworten

Name	Typ	Beschreibung
200 OK	ServerAzureADAdministrator	Ein Azure Active Directory-Administrator wurde erfolgreich aktualisiert.
201 Created	ServerAzureADAdministrator	Ein Azure Active Directory-Administrator wurde erfolgreich erstellt.
202 Accepted		Angenommen Header Location: string
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt 400 InvalidServerAdministratorTypePropertyName – Server Active Directory-Administratortyp sollte ActiveDirectory sein 400 InvalidResourceRequestBody – Die Ressourcen- oder Ressourceneigenschaften im Anforderungstext sind leer oder ungültig. 400 InvalidServerAzureADOnlyAuthenticationParameter – Der Benutzer hat versucht, den AzureADOnlyAuthentication-Parameter auf "false" festzulegen, der nicht zulässig ist. Verwenden Sie stattdessen die AzureADOnlyAuthentications-API. 400 InvalidServerAzureADAdminDeleteOperation – Benutzer hat versucht, den Azure Active Azure-Serveradministrator zu löschen, wenn AzureADOnlyAuthentication festgelegt ist, verwenden Sie zuerst die AzureADOnlyAuthentications-API. 400 ServerAdministratorNameAlreadyExists – Der Benutzer hat versucht, den externen Administrator festzulegen, und der Prinzipalname ist bereits in der Hauptdatenbank vorhanden. 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden. 409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann. 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

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=2023-08-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/stable/2023-08-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

Beispiel für eine Antwort

Statuscode:: 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
  }
}

Statuscode:: 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
  }
}

Statuscode:: 202

Definitionen

Name	Beschreibung
AdministratorName	Der Name des Server-Active Directory-Administrators.
AdministratorType	Typ des Serveradministrators.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ServerAzureADAdministrator	Azure Active Directory-Administrator.

AdministratorName

Enumeration

Der Name des Server-Active Directory-Administrators.

Wert	Beschreibung
ActiveDirectory

AdministratorType

Enumeration

Typ des Serveradministrators.

Wert	Beschreibung
ActiveDirectory

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ServerAzureADAdministrator

Objekt

Azure Active Directory-Administrator.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.administratorType	AdministratorType	Typ des Serveradministrators.
properties.azureADOnlyAuthentication	boolean	Nur Azure Active Directory-Authentifizierung aktiviert.
properties.login	string	Anmeldename des Serveradministrators.
properties.sid	string (uuid)	SID (Objekt-ID) des Serveradministrators.
properties.tenantId	string (uuid)	Mandanten-ID des Administrators.
type	string	Ressourcentyp.

Freigeben über

Server Azure AD Administrators - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Creates or updates an existing Azure Active Directory administrator.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AdministratorName

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerAzureADAdministrator