Managed Instance Azure AD Only Authentications - Create Or Update

Služba:

SQL Database

Verze rozhraní API:

2023-08-01

Nastaví pouze vlastnost ověřování služby Active Directory serveru nebo aktualizuje existující vlastnost ověřování služby Active Directory pouze serveru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
authenticationName	path	True	AuthenticationName	Název serveru azure active directory pouze ověřování.
managedInstanceName	path	True	string	Název spravované instance.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.azureADOnlyAuthentication	True	boolean	Je povoleno pouze ověřování Azure Active Directory.

Odpovědi

Name	Typ	Description
200 OK	ManagedInstanceAzureADOnlyAuthentication	Úspěšně se aktualizovala pouze vlastnost ověřování Azure Active Directory.
201 Created	ManagedInstanceAzureADOnlyAuthentication	Úspěšně se aktualizovala pouze vlastnost ověřování Azure Active Directory.
202 Accepted		Přijal Hlavičky Location: string
Other Status Codes	ErrorResponse	Chybové odpovědi: *** 400 InvalidServerAzureADOnlyAuthenticationParameter – Uživatel se pokusil nastavit parametr AzureADOnlyAuthentication na hodnotu false, což není povoleno, použijte místo toho rozhraní API azureADOnlyAuthentications. 400 InvalidManagedServerAAADOnlyAuthTypePropertyName – Jako výchozí by měl být pouze typ ověřování Azure Active Directory spravovaného serveru. 400 InvalidManagedServerAADOnlyAuthNoAADAdminPropertyName – Správce AAD není nakonfigurovaný, před povolením nebo zakázáním pouze ověřování AAD musí být nastaven správce AAD. 400 SubnetMissingRequiredDelegation – Vybraná podsíť není delegovaná pro spravovanou instanci SQL. 404 ManagedInstanceNotInSubscriptionResourceGroup – Zadaná spravovaná instance v zadané skupině prostředků a předplatném neexistuje. 404 SubscriptionNotFound – Požadované předplatné nebylo nalezeno. 404 ServerNotInSubscription – Zadaný server v zadaném předplatném neexistuje. 404 OperationIdNotFound – operace s ID neexistuje. 409 CannotCancelOperation – Operace správy je ve stavu, který nelze zrušit. 409 OperationCancelled - Operace byla zrušena uživatelem. 409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku. 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 504 RequestTimeout – Žádost o službu překročila povolený časový limit.

Příklady

Creates or updates Azure Active Directory only authentication object.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Stavový kód:

202

Definice

Name	Description
AuthenticationName	Název serveru azure active directory pouze ověřování.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ManagedInstanceAzureADOnlyAuthentication	Pouze ověřování Azure Active Directory.

AuthenticationName

Výčet

Název serveru azure active directory pouze ověřování.

Hodnota	Description
Default

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ManagedInstanceAzureADOnlyAuthentication

Objekt

Pouze ověřování Azure Active Directory.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.azureADOnlyAuthentication	boolean	Je povoleno pouze ověřování Azure Active Directory.
type	string	Typ prostředku.