Managed Instance Azure AD Only Authentications - Create Or Update

Serviço:: SQL Database

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

Define a propriedade de autenticação somente do Active Directory do Servidor ou atualiza uma propriedade de autenticação somente do Active Directory do servidor existente.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
authenticationName	path	True	AuthenticationName	O nome da autenticação somente do Azure Active Directory do servidor.
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 na API do Azure Resource Manager ou no portal.
subscriptionId	path	True	string	A ID da 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.azureADOnlyAuthentication	True	boolean	Somente autenticação do Azure Active Directory habilitada.

Respostas

Nome	Tipo	Description
200 OK	ManagedInstanceAzureADOnlyAuthentication	Atualizou com êxito uma propriedade de autenticação somente do Azure Active Directory.
201 Created	ManagedInstanceAzureADOnlyAuthentication	Propriedade de autenticação somente do Azure Active Directory atualizada com êxito.
202 Accepted		Aceitado Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 InvalidServerAzureADOnlyAuthenticationParameter – O usuário tentou definir o parâmetro AzureADOnlyAuthentication como false, o que não é permitido, use a API azureADOnlyAuthentications. 400 InvalidManagedServerAADOnlyAuthTypePropertyName – O tipo de autenticação somente do Azure Active Directory do Servidor Gerenciado deve ser Padrão 400 InvalidManagedServerAADOnlyAuthNoAADAdminPropertyName – O administrador do AAD não está configurado, o administrador do AAD deve ser definido antes de habilitar/desabilitar a Autenticação Somente do AAD. 400 SubnetMissingRequiredDelegation – A sub-rede selecionada não é delegada para a Instância Gerenciada de SQL. 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. 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 por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações 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 novamente a operação. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 504 RequestTimeout – A solicitação de serviço excedeu o tempo limite permitido.

Exemplos

Creates or updates Azure Active Directory only authentication object.

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

{
  "properties": {
    "azureADOnlyAuthentication": false
  }
}

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/ManagedInstanceAzureADOnlyAuthCreateOrUpdate.json
// this example is just showing the usage of "ManagedInstanceAzureADOnlyAuthentications_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 ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "managedInstance";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this ManagedInstanceAzureADOnlyAuthenticationResource
ManagedInstanceAzureADOnlyAuthenticationCollection collection = managedInstance.GetManagedInstanceAzureADOnlyAuthentications();

// invoke the operation
AuthenticationName authenticationName = AuthenticationName.Default;
ManagedInstanceAzureADOnlyAuthenticationData data = new ManagedInstanceAzureADOnlyAuthenticationData
{
    IsAzureADOnlyAuthenticationEnabled = false,
};
ArmOperation<ManagedInstanceAzureADOnlyAuthenticationResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, authenticationName, data);
ManagedInstanceAzureADOnlyAuthenticationResource 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
ManagedInstanceAzureADOnlyAuthenticationData 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 de exemplo

Código de status:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/azureADOnlyAuthentications/providers/Microsoft.Sql/managedInstances/managedInstance/azureadonlyauthentications/default",
  "name": "Default",
  "type": "Microsoft.Sql/managedInstances/azureadonlyauthentications",
  "properties": {
    "azureADOnlyAuthentication": false
  }
}

Código de status:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/azureADOnlyAuthentications/providers/Microsoft.Sql/managedInstances/managedInstance/azureadonlyauthentications/default",
  "name": "Default",
  "type": "Microsoft.Sql/managedInstances/azureadonlyauthentications",
  "properties": {
    "azureADOnlyAuthentication": false
  }
}

Código de status:: 202

Definições

Nome	Description
AuthenticationName	O nome da autenticação somente do Azure Active Directory do servidor.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedInstanceAzureADOnlyAuthentication	Autenticação somente do Azure Active Directory.

AuthenticationName

Enumeração

O nome da autenticação somente do Azure Active Directory do servidor.

Valor	Description
Default

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedInstanceAzureADOnlyAuthentication

Objeto

Autenticação somente do Azure Active Directory.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.azureADOnlyAuthentication	boolean	Somente autenticação do Azure Active Directory habilitada.
type	string	Tipo de recurso.

Compartilhar via

Managed Instance Azure AD Only Authentications - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Creates or updates Azure Active Directory only authentication object.

Solicitação de exemplo

Resposta de exemplo

Definições

AuthenticationName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceAzureADOnlyAuthentication