Server Azure AD Only Authentications - Get

Dienst:: SQL Database

API-Version:: 2023-08-01

Ruft eine bestimmte Nur-Azure Active Directory-Authentifizierungseigenschaft ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authenticationName	path	True	AuthenticationName	Der Name der server azure active directory-Authentifizierung.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ServerAzureADOnlyAuthentication	Eine angegebene Azure Active Directory-Authentifizierungseigenschaften wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 InvalidServerAzureADOnlyAuthenticationParameter – Der Benutzer hat versucht, den AzureADOnlyAuthentication-Parameter auf "false" festzulegen, der nicht zulässig ist. Verwenden Sie stattdessen die AzureADOnlyAuthentications-API. 400 InvalidServerAADOnlyAuthTypePropertyName – Server Azure Active Directory-Authentifizierungstyp sollte "Standard" sein. 400 InvalidServerAADOnlyAuthNoAADAdminPropertyName – AAD-Administrator ist nicht konfiguriert, AAD-Administrator muss festgelegt werden, bevor AAD-Authentifizierung aktiviert/deaktiviert wird. 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden.

Name

Typ

Beschreibung

200 OK

ServerAzureADOnlyAuthentication

Eine angegebene Azure Active Directory-Authentifizierungseigenschaften wurde erfolgreich abgerufen.

Other Status Codes

ErrorResponse

Fehlerantworten: ***

400 InvalidServerAzureADOnlyAuthenticationParameter – Der Benutzer hat versucht, den AzureADOnlyAuthentication-Parameter auf "false" festzulegen, der nicht zulässig ist. Verwenden Sie stattdessen die AzureADOnlyAuthentications-API.
400 InvalidServerAADOnlyAuthTypePropertyName – Server Azure Active Directory-Authentifizierungstyp sollte "Standard" sein.
400 InvalidServerAADOnlyAuthNoAADAdminPropertyName – AAD-Administrator ist nicht konfiguriert, AAD-Administrator muss festgelegt werden, bevor AAD-Authentifizierung aktiviert/deaktiviert wird.
400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird
400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt
404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.
404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.
404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden.

Beispiele

Gets a Azure Active Directory only authentication property.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/azureADOnlyAuthentications/Default?api-version=2023-08-01

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/AzureADOnlyAuthGet.json
// this example is just showing the usage of "ServerAzureADOnlyAuthentications_Get" 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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-4799";
string serverName = "sqlcrudtest-6440";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerAzureADOnlyAuthenticationResource
SqlServerAzureADOnlyAuthenticationCollection collection = sqlServer.GetSqlServerAzureADOnlyAuthentications();

// invoke the operation
AuthenticationName authenticationName = AuthenticationName.Default;
NullableResponse<SqlServerAzureADOnlyAuthenticationResource> response = await collection.GetIfExistsAsync(authenticationName);
SqlServerAzureADOnlyAuthenticationResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    SqlServerAzureADOnlyAuthenticationData 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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/azureadonlyauthentications/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/azureadonlyauthentications",
  "properties": {
    "azureADOnlyAuthentication": true
  }
}

Definitionen

Name	Beschreibung
AuthenticationName	Der Name der server azure active directory-Authentifizierung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ServerAzureADOnlyAuthentication	Nur Azure Active Directory-Authentifizierung.

AuthenticationName

Enumeration

Der Name der server azure active directory-Authentifizierung.

Wert	Beschreibung
Default

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.