Server Azure AD Administrators - Create Or Update

Serviço:

SQL Database

Versão da API:

2023-08-01

Cria ou atualiza um administrador existente do Azure Ative Directory.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
administratorName	path	True	AdministratorName	O nome do administrador do Ative Directory do servidor.
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.
serverName	path	True	string	O nome do servidor.
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.login	True	string	Nome de login do administrador do servidor.
properties.sid	True	string (uuid)	SID (ID do objeto) do administrador do servidor.
properties.administratorType		AdministratorType	Tipo de administrador de corte.
properties.tenantId		string (uuid)	ID do locatário do administrador.

Respostas

Name	Tipo	Description
200 OK	ServerAzureADAdministrator	Atualizado com êxito um administrador do Azure Ative Directory.
201 Created	ServerAzureADAdministrator	Criado com êxito um administrador do Azure Ative Directory.
202 Accepted		Aceito Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial 400 InvalidServerAdministratorTypePropertyName - O tipo de administrador do Ative Directory do servidor deve ser ActiveDirectory 400 InvalidResourceRequestBody - As propriedades do recurso ou do recurso no corpo da solicitação estão vazias ou são inválidas. 400 InvalidServerAzureADOnlyAuthenticationParameter - O usuário tentou definir o parâmetro AzureADOnlyAuthentication como false que não é permitido, use azureADOnlyAuthentications API em vez disso. 400 InvalidServerAzureADAdminDeleteOperation - O usuário tentou excluir o servidor Azure Ative Azure admin quando AzureADOnlyAuthentication está definido, use azureADOnlyAuthentications API primeiro. 400 ServerAdministratorNameAlreadyExists - O usuário tentou definir o administrador externo e o nome principal já existe no banco de dados 'master'. 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 OperationIdNotFound - A operação com Id não existe. 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. 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. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

Exemplos

Creates or updates an existing Azure Active Directory administrator.

Pedido de amostra

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

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

Resposta da amostra

Código de estado:

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

Código de estado:

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

Código de estado:

202

Definições

Name	Description
AdministratorName	O nome do administrador do Ative Directory do servidor.
AdministratorType	Tipo de administrador de corte.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ServerAzureADAdministrator	Administrador do Azure Ative Directory.

AdministratorName

Enumeração

O nome do administrador do Ative Directory do servidor.

Valor	Description
ActiveDirectory

AdministratorType

Enumeração

Tipo de administrador de corte.

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.

ServerAzureADAdministrator

Object

Administrador do Azure Ative Directory.

Name	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.administratorType	AdministratorType	Tipo de administrador de corte.
properties.azureADOnlyAuthentication	boolean	Somente Autenticação do Ative Directory do Azure habilitada.
properties.login	string	Nome de login do administrador do servidor.
properties.sid	string (uuid)	SID (ID do objeto) do administrador do servidor.
properties.tenantId	string (uuid)	ID do locatário do administrador.
type	string	Tipo de recurso.