Managed Instance Azure AD Only Authentications - Create Or Update

Servicio:: SQL Database

Versión de la API:: 2023-08-01

Establece solo la propiedad de autenticación de Servidor Active Directory o actualiza una propiedad de autenticación de active Directory 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 identificador URI

Nombre	En	Requerido	Tipo	Description
authenticationName	path	True	AuthenticationName	Nombre de la autenticación solo de Azure Active Directory del servidor.
managedInstanceName	path	True	string	Nombre de la instancia administrada.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.azureADOnlyAuthentication	True	boolean	Autenticación solo de Azure Active Directory habilitada.

Respuestas

Nombre	Tipo	Description
200 OK	ManagedInstanceAzureADOnlyAuthentication	Se ha actualizado correctamente una propiedad de autenticación solo de Azure Active Directory.
201 Created	ManagedInstanceAzureADOnlyAuthentication	Se actualizó correctamente la propiedad de autenticación solo de Azure Active Directory.
202 Accepted		Aceptado Encabezados Location: string
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 InvalidServerAzureADOnlyAuthenticationParameter: el usuario intentó establecer el parámetro AzureADOnlyAuthentication en false, que no está permitido, use azureADOnlyAuthentications API en su lugar. 400 InvalidManagedServerAADOnlyAuthTypePropertyName: el tipo de autenticación de Azure Active Directory solo del servidor administrado debe ser Predeterminado 400 InvalidManagedServerAADOnlyAuthNoAADAdminPropertyName: el administrador de AAD no está configurado, el administrador de AAD debe establecerse antes de habilitar o deshabilitar la autenticación solo de AAD. 400 SubredMissingRequiredDelegation: la subred seleccionada no está delegada para SQL Managed Instance. 404 ManagedInstanceNotInSubscriptionResourceGroup: la instancia administrada especificada no existe en el grupo de recursos y la suscripción especificados. 404 SubscriptionNotFound: no se encontró la suscripción solicitada. 404 ServerNotInSubscription: el servidor especificado no existe en la suscripción especificada. 404 OperationIdNotFound: la operación con id. no existe. 409 CannotCancelOperation: la operación de administración está en un estado que no se puede cancelar. 409 OperationCancelled: el usuario canceló la operación. 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió otra operación en el mismo recurso. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 504 RequestTimeout: la solicitud de servicio superó el tiempo de espera permitido.

Ejemplos

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://dori-uw-1.kuma-moon.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

Respuesta de muestra

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

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

status code:: 202

Definiciones

Nombre	Description
AuthenticationName	Nombre de la autenticación solo de Azure Active Directory del servidor.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ManagedInstanceAzureADOnlyAuthentication	Autenticación solo de Azure Active Directory.

AuthenticationName

Enumeración

Nombre de la autenticación solo de Azure Active Directory del servidor.

Valor	Description
Default

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ManagedInstanceAzureADOnlyAuthentication

Object

Autenticación solo de Azure Active Directory.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.azureADOnlyAuthentication	boolean	Autenticación solo de Azure Active Directory habilitada.
type	string	Tipo de recurso.

Compartir a través de

Managed Instance Azure AD Only Authentications - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Creates or updates Azure Active Directory only authentication object.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AuthenticationName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceAzureADOnlyAuthentication