Managed Instance Azure AD Only Authentications - Create Or Update

Servizio:

SQL Database

Versione API:

2023-08-01

Imposta solo la proprietà di autenticazione di Server Active Directory o aggiorna una proprietà di autenticazione di Active Directory solo server esistente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
authenticationName	path	True	AuthenticationName	Nome del server azure active directory solo autenticazione.
managedInstanceName	path	True	string	Nome dell'istanza gestita.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.azureADOnlyAuthentication	True	boolean	Autenticazione di Azure Active Directory abilitata solo.

Risposte

Nome	Tipo	Descrizione
200 OK	ManagedInstanceAzureADOnlyAuthentication	È stata aggiornata correttamente una proprietà di autenticazione solo di Azure Active Directory.
201 Created	ManagedInstanceAzureADOnlyAuthentication	Aggiornamento corretto della proprietà di autenticazione solo di Azure Active Directory.
202 Accepted		Accettato Intestazioni Location: string
Other Status Codes	ErrorResponse	Risposte di errore: 400 InvalidServerAzureADOnlyAuthenticationParameter- L'utente ha tentato di impostare il parametro AzureADOnlyAuthentication su false, ma usare invece l'API azureADOnlyAuthentications. 400 InvalidManagedServerAADOnlyAuthTypePropertyName - Il tipo di autenticazione di Azure Active Directory del server gestito deve essere predefinito 400 InvalidManagedServerAADOnlyAuthNoAADAdminPropertyName - L'amministratore di AAD non è configurato, l'amministratore di AAD deve essere impostato prima di abilitare o disabilitare solo l'autenticazione AAD. 400 SubnetMissingRequiredDelegation: la subnet selezionata non è delegata per Istanza gestita di SQL. 404 ManagedInstanceNotInSubscriptionResourceGroup: l'istanza gestita specificata non esiste nel gruppo di risorse e nella sottoscrizione specificati. 404 SubscriptionNotFound - La sottoscrizione richiesta non è stata trovata. 404 ServerNotInSubscription - Il server specificato non esiste nella sottoscrizione specificata. 404 OperationIdNotFound - L'operazione con ID non esiste. 409 CannotCancelOperation: l'operazione di gestione si trova in uno stato che non può essere annullato. 409 OperationCancelled - L'operazione è stata annullata dall'utente. 409 OperationInterrupted - Impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa. 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 429 SubscriptionTooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 429 SubscriptionTooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 500 OperationTimedOut: timeout dell'operazione e rollback automatico. Ripetere l'operazione. 503 TooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 503 TooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 504 RequestTimeout : la richiesta di servizio ha superato il timeout consentito.

Esempio

Creates or updates Azure Active Directory only authentication object.

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Codice di stato:

202

Definizioni

Nome	Descrizione
AuthenticationName	Nome del server azure active directory solo autenticazione.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ManagedInstanceAzureADOnlyAuthentication	Autenticazione solo di Azure Active Directory.

AuthenticationName

Enumerazione

Nome del server azure active directory solo autenticazione.

Valore	Descrizione
Default

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ManagedInstanceAzureADOnlyAuthentication

Object

Autenticazione solo di Azure Active Directory.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.azureADOnlyAuthentication	boolean	Autenticazione di Azure Active Directory abilitata solo.
type	string	Tipo di risorsa.