Managed Instance Administrators - Create Or Update

Služba:

SQL Database

Verze rozhraní API:

2023-08-01

Vytvoří nebo aktualizuje správce spravované instance.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
administratorName	path	True	AdministratorName
managedInstanceName	path	True	string	Název spravované instance.
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.
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.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.administratorType	True	ManagedInstanceAdministratorType	Typ správce spravované instance
properties.login	True	string	Přihlašovací jméno správce spravované instance
properties.sid	True	string (uuid)	IDENTIFIKÁTOR SID (ID objektu) správce spravované instance.
properties.tenantId		string (uuid)	ID tenanta správce spravované instance

Odpovědi

Name	Typ	Description
200 OK	ManagedInstanceAdministrator	Správce spravované instance byl úspěšně aktualizován.
201 Created	ManagedInstanceAdministrator	Správce spravované instance byl úspěšně vytvořen.
202 Accepted		Přijal Hlavičky Location: string
Other Status Codes	ErrorResponse	Chybové odpovědi: *** 400 SubnetMissingRequiredDelegation – Vybraná podsíť není delegovaná pro spravovanou instanci SQL. 400 InvalidManagedServerAdministratorType – Neplatný typ správce zadaný ve vlastnostech. 400 InvalidResourceRequestBody – vlastnost prostředku nebo prostředku v textu požadavku je prázdná nebo neplatná. 400 InvalidManagedServerAzureADAdminDeleteOperation – Uživatel se pokusil odstranit spravovaný server Azure Active Azure při nastavení AzureADOnlyAuthentication, nejprve použijte rozhraní API azureADOnlyAuthentications. 400 InvalidManagedServerAAADOnlyAuthTypePropertyName – Jako výchozí by měl být pouze typ ověřování Azure Active Directory spravovaného serveru. 400 ServerPrincipalCreateLoginBadSyntax – Při provádění příkazu Create Login pro správce Azure AD došlo k chybě syntaxe. 400 ManagedInstanceIsBusy – Spravovaná instance je zaneprázdněná jiným požadavkem. 400 InvalidLoginName – zadané přihlašovací jméno je neplatné. 400 ServicePrincipalLookupInAadFailedIdentityForbidden – Služba AzureAD Lookup selhala, protože MSI nebyla udělena oprávnění ke čtení pro AAD. 400 PrincipalNotFoundInTenant – Služba AzureAD Lookup nevrátila pro tento název žádné výsledky. 400 ServerPrincipalHasDuplicateDisplayNameInAad – Služba AzureAD Lookup vrátila více výsledků pro tento název. 400 InvalidPrincipalType – Tento typ objektu zabezpečení není ve službě Windows Azure SQL Database podporovaný. 400 InvalidParameterValue – Parametr dostal neplatnou hodnotu. 400 ServicePrincipalLookupInAadFailed – Služba AzureAD Lookup selhala kvůli chybám infrastruktury služeb. 400 TenantNotFoundInActiveDirectory – Tenant není ve službě Active Directory k dispozici. 400 InvalidUsername – Zadané uživatelské jméno obsahuje neplatné znaky. 400 ManagedInstanceHasNoPermissionsToAccessAad – pokus o provedení operace, která zahrnuje neexistující přihlášení nebo přihlášení, na kterém spuštěný objekt zabezpečení nemá žádná oprávnění. 404 ManagedInstanceNotInSubscriptionResourceGroup – Zadaná spravovaná instance v zadané skupině prostředků a předplatném neexistuje. 404 SubscriptionNotFound – Požadované předplatné nebylo nalezeno. 404 ServerNotInSubscription – Zadaný server v zadaném předplatném neexistuje. 404 OperationIdNotFound – operace s ID neexistuje. 404 ResourceNotFound – Požadovaný prostředek nebyl nalezen. 409 CannotCancelOperation – Operace správy je ve stavu, který nelze zrušit. 409 OperationCancelled - Operace byla zrušena uživatelem. 409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku. 409 ServerPrincipalOwnsJobs – pokus o odebrání přihlášení, pokud má aktivní úlohy. 409 ServerPrincipalOwnsObjects – pokus o vyřazení přihlášení, které vlastní objekty. 409 ServerPrincipalIsGrantorOfPermissions - Pokus o vyřazení objektu zabezpečení serveru, což je udělení oprávnění. 409 ServerPrincipalOwnsDatabase – před vyřazením přihlášení změňte vlastníka databází. 409 ServerPrincipalCurrentlyLoggedIn - self-vysvětlující. 409 ServerPrincipalAlreadyExists – pokus o vytvoření objektu zabezpečení serveru s jiným jedinečným názvem. 409 ServerPrincipalUsedInTriggerOrEventNotification - Pokus o odstranění přihlášení, který se používá jako kontext spuštění triggeru nebo oznámení události. 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat. 500 ActiveDirectoryLookupTimedOut – operaci nelze v tuto chvíli dokončit. Zkuste to prosím znovu později. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 504 RequestTimeout – Žádost o službu překročila povolený časový limit.

Příklady

Create administrator of managed instance

Update administrator of managed instance

Create administrator of managed instance

Ukázkový požadavek

HTTP

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

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/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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Stavový kód:

202

Update administrator of managed instance

Ukázkový požadavek

HTTP

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

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/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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Stavový kód:

202

Definice

Name	Description
AdministratorName
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ManagedInstanceAdministrator	Správce spravované instance Azure SQL.
ManagedInstanceAdministratorType	Typ správce spravované instance

AdministratorName

Výčet

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.

ManagedInstanceAdministrator

Objekt

Správce spravované instance Azure SQL.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.administratorType	ManagedInstanceAdministratorType	Typ správce spravované instance
properties.login	string	Přihlašovací jméno správce spravované instance
properties.sid	string (uuid)	IDENTIFIKÁTOR SID (ID objektu) správce spravované instance.
properties.tenantId	string (uuid)	ID tenanta správce spravované instance
type	string	Typ prostředku.

ManagedInstanceAdministratorType

Výčet

Typ správce spravované instance

Hodnota	Description
ActiveDirectory