Managed Instance Azure AD Only Authentications - Create Or Update

Usługa:: SQL Database

Wersja interfejsu API:: 2023-08-01

Ustawia tylko właściwość uwierzytelniania usługi Active Directory serwera lub aktualizuje istniejącą właściwość uwierzytelniania tylko usługi Active Directory.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
authenticationName	path	True	AuthenticationName	Nazwa serwera uwierzytelniania tylko w usłudze Azure Active Directory.
managedInstanceName	path	True	string	Nazwa wystąpienia zarządzanego.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.azureADOnlyAuthentication	True	boolean	Włączono tylko uwierzytelnianie usługi Azure Active Directory.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ManagedInstanceAzureADOnlyAuthentication	Pomyślnie zaktualizowano właściwość uwierzytelniania tylko w usłudze Azure Active Directory.
201 Created	ManagedInstanceAzureADOnlyAuthentication	Pomyślnie zaktualizowano właściwość uwierzytelniania tylko w usłudze Azure Active Directory.
202 Accepted		Akceptowane Nagłówki Location: string
Other Status Codes	ErrorResponse	Odpowiedzi na błędy: *** 400 InvalidServerAzureADOnlyAuthenticationParameter — użytkownik próbował ustawić parametr AzureADOnlyAuthentication na wartość false, która nie jest dozwolona, zamiast tego użyj interfejsu API azureADOnlyAuthentications. 400 InvalidManagedServerAADOnlyAuthTypePropertyName — typ uwierzytelniania tylko dla usługi Azure Active Directory serwera zarządzanego powinien być domyślny 400 InvalidManagedServerAADOnlyAuthNoAADAdminPropertyName — administrator usługi AAD nie jest skonfigurowany, administrator usługi AAD musi być ustawiony przed włączeniem/wyłączeniem uwierzytelniania tylko usługi AAD. 400 PodsiećMissingRequiredDelegation — wybrana podsieć nie jest delegowana dla usługi SQL Managed Instance. 404 ManagedInstanceNotInSubscriptionResourceGroup — określone wystąpienie zarządzane nie istnieje w określonej grupie zasobów i subskrypcji. 404 SubscriptionNotFound — żądana subskrypcja nie została znaleziona. 404 ServerNotInSubscription — określony serwer nie istnieje w określonej subskrypcji. 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje. 409 CannotCancelOperation — operacja zarządzania jest w stanie, którego nie można anulować. 409 OperationCancelled — operacja została anulowana przez użytkownika. 409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie. 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby. 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby. 500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji. 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 504 RequestTimeout — żądanie obsługi przekroczyło dozwolony limit czasu.

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Kod stanu:: 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
  }
}

Kod stanu:: 202

Definicje

Nazwa	Opis
AuthenticationName	Nazwa serwera uwierzytelniania tylko w usłudze Azure Active Directory.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ManagedInstanceAzureADOnlyAuthentication	Uwierzytelnianie tylko w usłudze Azure Active Directory.

AuthenticationName

Wyliczanie

Nazwa serwera uwierzytelniania tylko w usłudze Azure Active Directory.

Wartość	Opis
Default

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ManagedInstanceAzureADOnlyAuthentication

Objekt

Uwierzytelnianie tylko w usłudze Azure Active Directory.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.azureADOnlyAuthentication	boolean	Włączono tylko uwierzytelnianie usługi Azure Active Directory.
type	string	Typ zasobu.

Udostępnij przez

Managed Instance Azure AD Only Authentications - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Creates or updates Azure Active Directory only authentication object.

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AuthenticationName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceAzureADOnlyAuthentication