Server Azure AD Administrators - Create Or Update

Referência

Service:: SQL Database

API Version:: 2021-11-01

Cria ou atualiza um administrador existente do Azure Active Directory.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
administratorName	path	True	AdministratorName	O nome do administrador do active directory do servidor.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio 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 da solicitação

Nome	Obrigatório	Tipo	Description
properties.administratorType	True	AdministratorType	Tipo do administrador de sever.
properties.login	True	string	Nome de logon do administrador do servidor.
properties.sid	True	string	SID (ID do objeto) do administrador do servidor.
properties.tenantId		string	ID do locatário do administrador.

Respostas

Nome	Tipo	Description
200 OK	ServerAzureADAdministrator	Atualizado com êxito um administrador do Azure Active Directory.
201 Created	ServerAzureADAdministrator	Criou com êxito um administrador do Azure Active Directory.
202 Accepted		Aceito
Other Status Codes		Respostas de erro: *** 400 InvalidServerAdministratorTypePropertyName – O tipo de administrador do Active Directory do servidor deve ser ActiveDirectory 400 InvalidResourceRequestBody - O recurso ou as propriedades do recurso no corpo da solicitação são vazios ou inválidos. 400 InvalidServerAzureADOnlyAuthenticationParameter – O usuário tentou definir o parâmetro AzureADOnlyAuthentication como false, o que não é permitido, use a API azureADOnlyAuthentications. 400 InvalidServerAzureADAdminDeleteOperation – o usuário tentou excluir o administrador do Azure Active Azure do servidor quando a AzureADOnlyAuthentication estiver definida, use primeiro a API azureADOnlyAuthentications. 400 ServerAdministratorNameAlreadyExists – o usuário tentou definir o administrador externo e o nome principal já existe no banco de dados 'master'. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 OperationIdNotFound – A operação com id não existe. 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 das solicitações máximas que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Tente executar a operação novamente. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Exemplos

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=2021-11-01

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerAzureADAdministratorInner;
import com.azure.resourcemanager.sql.models.AdministratorName;
import com.azure.resourcemanager.sql.models.AdministratorType;
import java.util.UUID;

/** Samples for ServerAzureADAdministrators CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/AdministratorCreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates an existing Azure Active Directory administrator.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createsOrUpdatesAnExistingAzureActiveDirectoryAdministrator(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAzureADAdministrators().createOrUpdate("sqlcrudtest-4799",
            "sqlcrudtest-6440", AdministratorName.ACTIVE_DIRECTORY,
            new ServerAzureADAdministratorInner().withAdministratorType(AdministratorType.ACTIVE_DIRECTORY)
                .withLogin("bob@contoso.com").withSid(UUID.fromString("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"))
                .withTenantId(UUID.fromString("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c")),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 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
  }
}

Status code:: 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
  }
}

Status code:: 202

Definições

Nome	Description
AdministratorName	O nome do administrador do active directory do servidor.
AdministratorType	Tipo do administrador de sever.
ServerAzureADAdministrator	Administrador do Azure Active Directory.

AdministratorName

O nome do administrador do active directory do servidor.

Nome	Tipo	Description
ActiveDirectory	string

AdministratorType

Tipo do administrador de sever.

Nome	Tipo	Description
ActiveDirectory	string

ServerAzureADAdministrator

Administrador do Azure Active Directory.

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