Managed Instance Administrators - Create Or Update

Dienst:: SQL Database

API-Version:: 2023-08-01

Erstellt oder aktualisiert einen Administrator einer verwalteten Instanz.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
administratorName	path	True	AdministratorName
managedInstanceName	path	True	string	Der Name der verwalteten Instanz.
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.
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.administratorType	True	ManagedInstanceAdministratorType	Typ des Administrators der verwalteten Instanz.
properties.login	True	string	Anmeldename des Administrators der verwalteten Instanz.
properties.sid	True	string (uuid)	SID (Objekt-ID) des Administrators der verwalteten Instanz.
properties.tenantId		string (uuid)	Mandanten-ID des Administrators der verwalteten Instanz.

Antworten

Name	Typ	Beschreibung
200 OK	ManagedInstanceAdministrator	Der Administrator der verwalteten Instanz wurde erfolgreich aktualisiert.
201 Created	ManagedInstanceAdministrator	Der Administrator der verwalteten Instanz wurde erfolgreich erstellt.
202 Accepted		Angenommen Header Location: string
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 SubnetMissingRequiredDelegation – Ausgewähltes Subnetz wird für die verwaltete SQL-Instanz nicht delegiert. 400 InvalidManagedServerAdministratorType – Ungültiger Administratortyp, der in Eigenschaften angegeben ist. 400 InvalidResourceRequestBody – Die Ressourcen- oder Ressourceneigenschaften im Anforderungstext sind leer oder ungültig. 400 InvalidManagedServerAzureADAdminDeleteOperation – Der Benutzer hat versucht, verwalteten Server Azure Active Azure-Administrator zu löschen, wenn AzureADOnlyAuthentication festgelegt ist. Verwenden Sie zuerst die AzureADOnlyAuthentications-API. 400 InvalidManagedServerAADOnlyAuthTypePropertyName – Verwalteter Server Azure Active Directory-Authentifizierungstyp sollte "Standard" sein. 400 ServerPrincipalCreateLoginBadSyntax – Beim Ausführen der Create Login-Anweisung für Azure AD-Administrator ist ein Syntaxfehler aufgetreten. 400 ManagedInstanceIsBusy – Verwaltete Instanz ist mit einer anderen Anforderung beschäftigt. 400 InvalidLoginName – Der angegebene Anmeldename ist ungültig. 400 ServicePrincipalLookupInAadFailedIdentityForbidden – AzureAD Lookup failed because MSI was not granted read permissions on AAD. 400 PrincipalNotFoundInTenant – AzureAD Lookup hat keine Ergebnisse für diesen Namen zurückgegeben. 400 ServerPrincipalHasDuplicateDisplayNameInAad – AzureAD Lookup hat mehrere Ergebnisse für diesen Namen zurückgegeben. 400 InvalidPrincipalType – Dieser Prinzipaltyp wird in der Windows Azure SQL-Datenbank nicht unterstützt. 400 InvalidParameterValue – Ein ungültiger Wert wurde einem Parameter zugewiesen. 400 ServicePrincipalLookupInAadFailed – AzureAD Lookup aufgrund von Dienstinfrastrukturfehlern fehlgeschlagen. 400 TenantNotFoundInActiveDirectory – Mandant ist in Active Directory nicht verfügbar. 400 InvalidUsername – Der angegebene Benutzername enthält ungültige Zeichen. 400 ManagedInstanceHasNoPermissionsToAccessAad – Versuch, einen Vorgang auszuführen, der eine nicht vorhandene Anmeldung oder Anmeldung umfasst, für die der Ausführungsprinzipal keine Berechtigungen besitzt. 404 ManagedInstanceNotInSubscriptionResourceGroup – Angegebene verwaltete Instanz ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionNotFound – Das angeforderte Abonnement wurde nicht gefunden. 404 ServerNotInSubscription – Der angegebene Server ist für das angegebene Abonnement nicht vorhanden. 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden. 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. 409 ServerPrincipalOwnsJobs – Versuchen Sie, eine Anmeldung zu entfernen, wenn sie über aktive Aufträge verfügt. 409 ServerPrincipalOwnsObjects – Versuch, eine Anmeldung abzulegen, die Objekte besitzt. 409 ServerPrincipalIsGrantorOfPermissions – Versuch, einen Serverprinzipal abzulegen, bei dem es sich um einen Berechtigungserteilungsgeber handelt. 409 ServerPrincipalOwnsDatabase – Ändern Sie den Besitzer der Datenbank(en), bevor Sie die Anmeldung ablegen. 409 ServerPrincipalCurrentlyLoggedIn – Selbsterklärend. 409 ServerPrincipalAlreadyExists – Versuch, den Serverprinzipal mit nicht eindeutigen Namen zu erstellen. 409 ServerPrincipalUsedInTriggerOrEventNotification – Versuch, die Anmeldung abzulegen, die als Ausführungskontext eines Triggers oder einer Ereignisbenachrichtigung verwendet wird. 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. 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. 500 ActiveDirectoryLookupTimedOut – Der Vorgang konnte zurzeit nicht abgeschlossen werden. Versuchen Sie es später erneut. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 504 RequestTimeout – Serviceanforderung hat das zulässige Timeout überschritten.

Beispiele

Create administrator of managed instance

Update administrator of managed instance

Create administrator of managed instance

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory?api-version=2023-08-01

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  }
}

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/ManagedInstanceAdministratorCreate.json
// this example is just showing the usage of "ManagedInstanceAdministrators_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 ManagedInstanceAdministratorResource created on azure
// for more information of creating ManagedInstanceAdministratorResource, please refer to the document of ManagedInstanceAdministratorResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "managedInstance";
SqlAdministratorName administratorName = SqlAdministratorName.ActiveDirectory;
ResourceIdentifier managedInstanceAdministratorResourceId = ManagedInstanceAdministratorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, administratorName);
ManagedInstanceAdministratorResource managedInstanceAdministrator = client.GetManagedInstanceAdministratorResource(managedInstanceAdministratorResourceId);

// invoke the operation
ManagedInstanceAdministratorData data = new ManagedInstanceAdministratorData
{
    AdministratorType = ManagedInstanceAdministratorType.ActiveDirectory,
    Login = "bob@contoso.com",
    Sid = Guid.Parse("44444444-3333-2222-1111-000000000000"),
    TenantId = Guid.Parse("55555555-4444-3333-2222-111111111111"),
};
ArmOperation<ManagedInstanceAdministratorResource> lro = await managedInstanceAdministrator.UpdateAsync(WaitUntil.Completed, data);
ManagedInstanceAdministratorResource 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
ManagedInstanceAdministratorData 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/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

Statuscode:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

Statuscode:: 202

Update administrator of managed instance

Beispielanforderung

HTTP
dotnet

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory?api-version=2023-08-01

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  }
}

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/ManagedInstanceAdministratorUpdate.json
// this example is just showing the usage of "ManagedInstanceAdministrators_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 ManagedInstanceAdministratorResource created on azure
// for more information of creating ManagedInstanceAdministratorResource, please refer to the document of ManagedInstanceAdministratorResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "managedInstance";
SqlAdministratorName administratorName = SqlAdministratorName.ActiveDirectory;
ResourceIdentifier managedInstanceAdministratorResourceId = ManagedInstanceAdministratorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, administratorName);
ManagedInstanceAdministratorResource managedInstanceAdministrator = client.GetManagedInstanceAdministratorResource(managedInstanceAdministratorResourceId);

// invoke the operation
ManagedInstanceAdministratorData data = new ManagedInstanceAdministratorData
{
    AdministratorType = ManagedInstanceAdministratorType.ActiveDirectory,
    Login = "bob@contoso.com",
    Sid = Guid.Parse("44444444-3333-2222-1111-000000000000"),
    TenantId = Guid.Parse("55555555-4444-3333-2222-111111111111"),
};
ArmOperation<ManagedInstanceAdministratorResource> lro = await managedInstanceAdministrator.UpdateAsync(WaitUntil.Completed, data);
ManagedInstanceAdministratorResource 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
ManagedInstanceAdministratorData 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/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

Statuscode:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

Statuscode:: 202

Definitionen

Name	Beschreibung
AdministratorName
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ManagedInstanceAdministrator	Ein Von Azure SQL verwalteter Instanzadministrator.
ManagedInstanceAdministratorType	Typ des Administrators der verwalteten Instanz.

AdministratorName

Enumeration

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.

ManagedInstanceAdministrator

Objekt

Ein Von Azure SQL verwalteter Instanzadministrator.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.administratorType	ManagedInstanceAdministratorType	Typ des Administrators der verwalteten Instanz.
properties.login	string	Anmeldename des Administrators der verwalteten Instanz.
properties.sid	string (uuid)	SID (Objekt-ID) des Administrators der verwalteten Instanz.
properties.tenantId	string (uuid)	Mandanten-ID des Administrators der verwalteten Instanz.
type	string	Ressourcentyp.

ManagedInstanceAdministratorType

Enumeration

Typ des Administrators der verwalteten Instanz.

Wert	Beschreibung
ActiveDirectory

Freigeben über

Managed Instance Administrators - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create administrator of managed instance

Beispielanforderung

Beispiel für eine Antwort

Update administrator of managed instance

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AdministratorName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceAdministrator

ManagedInstanceAdministratorType