Server Azure AD Administrators - Create Or Update

Service:: SQL Database

API-versie:: 2023-08-01

Hiermee maakt of werkt u een bestaande Azure Active Directory-beheerder bij.

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

URI-parameters

Name	In	Vereist	Type	Description
administratorName	path	True	AdministratorName	De naam van de active directory-beheerder van de server.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Vereist	Type	Description
properties.login	True	string	Aanmeldingsnaam van de serverbeheerder.
properties.sid	True	string (uuid)	SID (object-id) van de serverbeheerder.
properties.administratorType		AdministratorType	Type van de serverbeheerder.
properties.tenantId		string (uuid)	Tenant-id van de beheerder.

Antwoorden

Name	Type	Description
200 OK	ServerAzureADAdministrator	Een Azure Active Directory-beheerder is bijgewerkt.
201 Created	ServerAzureADAdministrator	Er is een Azure Active Directory-beheerder gemaakt.
202 Accepted		Geaccepteerd Kopteksten Location: string
Other Status Codes	ErrorResponse	Foutreacties: *** 400 ManagedInstanceStoppingOrStopped - Conflicterende bewerking verzonden terwijl het exemplaar de status gestopt/gestopt heeft 400 ManagedInstanceStarting - Conflicterende bewerking verzonden terwijl het exemplaar de beginstatus heeft 400 InvalidServerAdministratorTypePropertyName - Server active directory administrator type moet ActiveDirectory zijn 400 InvalidResourceRequestBody: de resource- of resource-eigenschappen in de hoofdtekst van de aanvraag zijn leeg of ongeldig. 400 InvalidServerAzureADOnlyAuthenticationParameter: gebruiker heeft geprobeerd om de parameter AzureADOnlyAuthentication in te stellen op false. Gebruik in plaats daarvan de AZUREADOnlyAuthentications-API. 400 InvalidServerAzureADAdminDeleteOperation : gebruiker heeft geprobeerd de Azure Active Azure-beheerder van de server te verwijderen wanneer AzureADOnlyAuthentication is ingesteld. Gebruik eerst de API azureADOnlyAuthentications. 400 ServerAdministratorNameAlreadyExists - Gebruiker heeft geprobeerd de externe beheerder in te stellen en de principal-naam bestaat al in de hoofddatabase. 404 ServerNotInSubscriptionResourceGroup - Opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement. 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 OperationIdNotFound - De bewerking met id bestaat niet. 409 CannotCancelOperation - De beheerbewerking heeft een status die niet kan worden geannuleerd. 409 OperationCancelled - De bewerking is geannuleerd door de gebruiker. 409 Bewerking onderbroken: de bewerking op de resource kan niet worden voltooid omdat deze is onderbroken door een andere bewerking op dezelfde resource. 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 429 SubscriptionTooManyRequests : aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 500 OperationTimedOut: er is een time-out opgetreden voor de bewerking en wordt automatisch teruggedraaid. Voer de bewerking opnieuw uit. 503 TooManyRequests : aanvragen die buiten het maximum aantal aanvragen kunnen worden verwerkt door beschikbare resources.

Voorbeelden

Creates or updates an existing Azure Active Directory administrator.

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

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"
  }
}

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/AdministratorCreateOrUpdate.json
// this example is just showing the usage of "ServerAzureADAdministrators_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://free.blessedness.top/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 SqlServerAzureADAdministratorResource
SqlServerAzureADAdministratorCollection collection = sqlServer.GetSqlServerAzureADAdministrators();

// invoke the operation
SqlAdministratorName administratorName = SqlAdministratorName.ActiveDirectory;
SqlServerAzureADAdministratorData data = new SqlServerAzureADAdministratorData
{
    AdministratorType = SqlAdministratorType.ActiveDirectory,
    Login = "bob@contoso.com",
    Sid = Guid.Parse("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
    TenantId = Guid.Parse("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
};
ArmOperation<SqlServerAzureADAdministratorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, administratorName, data);
SqlServerAzureADAdministratorResource 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
SqlServerAzureADAdministratorData 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

Voorbeeldrespons

Statuscode:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "type": "Microsoft.Sql/servers/administrators",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "azureADOnlyAuthentication": true
  }
}

Statuscode:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators/ActiveDirectory",
  "name": "activeDirectory",
  "type": "Microsoft.Sql/servers/administrators",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "azureADOnlyAuthentication": true
  }
}

Statuscode:: 202

Definities

Name	Description
AdministratorName	De naam van de active directory-beheerder van de server.
AdministratorType	Type van de serverbeheerder.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ServerAzureADAdministrator	Azure Active Directory-beheerder.

AdministratorName

Inventarisatie

De naam van de active directory-beheerder van de server.

Waarde	Description
ActiveDirectory

AdministratorType

Inventarisatie

Type van de serverbeheerder.

Waarde	Description
ActiveDirectory

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ServerAzureADAdministrator

Object

Azure Active Directory-beheerder.

Name	Type	Description
id	string	Resource-id.
name	string	Resourcenaam.
properties.administratorType	AdministratorType	Type van de serverbeheerder.
properties.azureADOnlyAuthentication	boolean	Alleen azure Active Directory-verificatie ingeschakeld.
properties.login	string	Aanmeldingsnaam van de serverbeheerder.
properties.sid	string (uuid)	SID (object-id) van de serverbeheerder.
properties.tenantId	string (uuid)	Tenant-id van de beheerder.
type	string	Resourcetype.

Delen via

Server Azure AD Administrators - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Voorbeelden

Creates or updates an existing Azure Active Directory administrator.

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AdministratorName

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerAzureADAdministrator