Managed Instance Administrators - Create Or Update

Serviço:: SQL Database

Versão da API:: 2023-08-01

Cria ou atualiza um administrador de instância gerenciado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
administratorName	path	True	AdministratorName
managedInstanceName	path	True	string	O nome da instância gerenciada.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.administratorType	True	ManagedInstanceAdministratorType	Tipo de administrador da instância gerenciada.
properties.login	True	string	Nome de login do administrador da instância gerenciada.
properties.sid	True	string (uuid)	SID (ID do objeto) do administrador da instância gerenciada.
properties.tenantId		string (uuid)	ID do locatário do administrador da instância gerenciada.

Respostas

Name	Tipo	Description
200 OK	ManagedInstanceAdministrator	Atualizado com êxito o administrador da instância gerenciada.
201 Created	ManagedInstanceAdministrator	Criado com êxito o administrador da instância gerenciada.
202 Accepted		Aceito Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 SubnetMissingRequiredDelegation - A sub-rede selecionada não é delegada para a Instância Gerenciada SQL. 400 InvalidManagedServerAdministratorType - Tipo de administrador inválido especificado em propriedades. 400 InvalidResourceRequestBody - As propriedades do recurso ou do recurso no corpo da solicitação estão vazias ou são inválidas. 400 InvalidManagedServerAzureADAdminDeleteOperation - O usuário tentou excluir o servidor gerenciado Azure Ative Azure admin quando AzureADOnlyAuthentication está definido, use azureADOnlyAuthentications API primeiro. 400 InvalidManagedServerAADOnlyAuthTypePropertyName - Servidor Gerenciado Somente o tipo de autenticação do Azure Ative Directory deve ser Padrão 400 ServerPrincipalCreateLoginBadSyntax - Houve um erro de sintaxe ao executar a instrução Create Login para o Administrador do Azure AD. 400 ManagedInstanceIsBusy - A instância gerenciada está ocupada com outra solicitação. 400 InvalidLoginName - O nome de login fornecido é inválido. 400 ServicePrincipalLookupInAadFailedIdentityForbidden - A pesquisa do AzureAD falhou porque o MSI não recebeu permissões de leitura no AAD. 400 PrincipalNotFoundInTenant - AzureAD Lookup não retornou nenhum resultado para esse nome. 400 ServerPrincipalHasDuplicateDisplayNameInAad - AzureAD Lookup retornou vários resultados para esse nome. 400 InvalidPrincipalType - Este tipo principal não é suportado no Banco de dados SQL do Windows Azure. 400 InvalidParameterValue - Um valor inválido foi dado a um parâmetro. 400 ServicePrincipalLookupInAadFailed - A pesquisa do AzureAD falhou devido a erros de infraestrutura de serviço. 400 TenantNotFoundInActiveDirectory - O locatário não está disponível no Ative Directory. 400 InvalidUsername - O nome de usuário fornecido contém caracteres inválidos. 400 ManagedInstanceHasNoPermissionsToAccessAad - Tentativa de executar a operação, que envolve um login não existente ou login no qual a entidade de execução não tem permissões. 404 ManagedInstanceNotInSubscriptionResourceGroup - A instância gerenciada especificada não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionNotFound - A assinatura solicitada não foi encontrada. 404 ServerNotInSubscription - O servidor especificado não existe na assinatura especificada. 404 OperationIdNotFound - A operação com Id não existe. 404 ResourceNotFound - O recurso solicitado não foi encontrado. 409 CannotCancelOperation - A operação de gerenciamento está em um estado que não pode ser cancelado. 409 OperationCancelled - A operação foi cancelada pelo usuário. 409 OperationInterrupted - A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 409 ServerPrincipalOwnsJobs - Tente remover um login quando ele tiver trabalhos ativos. 409 ServerPrincipalOwnsObjects - Tente soltar um login, que possui objetos. 409 ServerPrincipalIsGrantorOfPermissions - Tente descartar uma entidade de servidor, que é um concedente de permissões. 409 ServerPrincipalOwnsDatabase - Altere o proprietário do(s) banco(s) de dados antes de descartar o login. 409 ServerPrincipalCurrentlyLoggedIn - Autoexplicativo. 409 ServerPrincipalAlreadyExists - Tente criar a entidade de servidor com nome não exclusivo. 409 ServerPrincipalUsedInTriggerOrEventNotification - Tentativa de descartar o login, que é usado como um contexto de execução de um gatilho ou notificação de evento. 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Por favor, tente novamente a operação. 500 ActiveDirectoryLookupTimedOut - A operação não pôde ser concluída no momento. Tente novamente mais tarde. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 504 RequestTimeout - A solicitação de serviço excedeu o tempo limite permitido.

Exemplos

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

Resposta da amostra

Código de estado:: 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"
}

Código de estado:: 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"
}

Código de estado:: 202

Update administrator of managed instance

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
}

Código de estado:: 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"
}

Código de estado:: 202

Definições

Name	Description
AdministratorName
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedInstanceAdministrator	Um administrador de instância gerenciada SQL do Azure.
ManagedInstanceAdministratorType	Tipo de administrador da instância gerenciada.

AdministratorName

Enumeração

Valor	Description
ActiveDirectory

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedInstanceAdministrator

Object

Um administrador de instância gerenciada SQL do Azure.

Name	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.administratorType	ManagedInstanceAdministratorType	Tipo de administrador da instância gerenciada.
properties.login	string	Nome de login do administrador da instância gerenciada.
properties.sid	string (uuid)	SID (ID do objeto) do administrador da instância gerenciada.
properties.tenantId	string (uuid)	ID do locatário do administrador da instância gerenciada.
type	string	Tipo de recurso.

ManagedInstanceAdministratorType

Enumeração

Tipo de administrador da instância gerenciada.

Valor	Description
ActiveDirectory

Partilhar via

Managed Instance Administrators - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Create administrator of managed instance

Pedido de amostra

Resposta da amostra

Update administrator of managed instance

Pedido de amostra

Resposta da amostra

Definições

AdministratorName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceAdministrator

ManagedInstanceAdministratorType