Dela via

Server Azure AD Administrators - Create Or Update

Tjänst:
SQL Database
API-version:
2025-01-01

Skapar eller uppdaterar en befintlig Azure Active Directory-administratör.

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

URI-parametrar

Name I Obligatorisk Typ Description
administratorName
 path True

AdministratorName

Namnet på server active directory-administratören.
resourceGroupName
 path True

string

Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName
 path True

string

Namnet på servern.
subscriptionId
 path True

string

Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version
 query True

string

DEN API-version som ska användas för begäran.

Begärandetext

Name Obligatorisk Typ Description
properties.login True

string

Serveradministratörens inloggningsnamn.
properties.sid True

string (uuid)

SID (objekt-ID) för serveradministratören.
properties.administratorType

AdministratorType

Typ av administratör för serverservern.
properties.tenantId

string (uuid)

Administratörens klientorganisations-ID.

Svar

Name Typ Description
200 OK

ServerAzureADAdministrator

En Azure Active Directory-administratör har uppdaterats.
201 Created

ServerAzureADAdministrator

En Azure Active Directory-administratör har skapats.
202 Accepted

Accepted

Sidhuvuden

Location: string
Other Status Codes

ErrorResponse

Felsvar: ***

  • 400 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd

  • 400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd

  • 400 InvalidServerAdministratorTypePropertyName – Server active directory-administratörstypen bör vara ActiveDirectory

  • 400 InvalidResourceRequestBody – Resurs- eller resursegenskaperna i begärandetexten är tomma eller ogiltiga.

  • 400 InvalidServerAzureADOnlyAuthenticationParameter – Användaren försökte ange parametern AzureADOnlyAuthentication till false vilket inte är tillåtet. Använd azureADOnlyAuthentications API i stället.

  • 400 InvalidServerAzureADAdminDeleteOperation – Användaren försökte ta bort serverns Azure Active Azure-administratör när AzureADOnlyAuthentication har angetts. Använd först API:et azureADOnlyAuthentications.

  • 400 ServerAdministratorNameAlreadyExists – Användaren försökte ange den externa administratören och huvudnamnet finns redan i huvuddatabasen.

  • 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.

  • 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte

  • 404 OperationIdNotFound – Åtgärden med ID finns inte.

  • 409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas.

  • 409 OperationCancelled – Åtgärden har avbrutits av användaren.

  • 409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs.

  • 429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

  • 429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser.

  • 500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök att utföra åtgärden igen.

  • 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

Creates or updates an existing Azure Active Directory administrator.

Exempelbegäran

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

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

Exempelsvar

Statuskod:
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
  }
}
Statuskod:
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
  }
}
Statuskod:
202

Definitioner

Name Description
AdministratorName

Namnet på server active directory-administratören.
AdministratorType

Typ av administratör för serverservern.
ErrorAdditionalInfo

Resurshanteringsfelet ytterligare information.
ErrorDetail

Detaljerna om felet.
ErrorResponse

Felsvar
ServerAzureADAdministrator

Azure Active Directory-administratör.

AdministratorName

Uppräkning

Namnet på server active directory-administratören.

Värde Description
ActiveDirectory

AdministratorType

Uppräkning

Typ av administratör för serverservern.

Värde Description
ActiveDirectory

ErrorAdditionalInfo

Objekt

Resurshanteringsfelet ytterligare information.

Name Typ Description
info

object

Den ytterligare informationen.
type

string

Typen av ytterligare information.

ErrorDetail

Objekt

Detaljerna om felet.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Felet ytterligare information.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felet objektet.

ServerAzureADAdministrator

Objekt

Azure Active Directory-administratör.

Name Typ Description
id

string

Resursidentifikator.
name

string

Resursnamn.
properties.administratorType

AdministratorType

Typ av administratör för serverservern.
properties.azureADOnlyAuthentication

boolean

Endast Azure Active Directory-autentisering aktiverat.
properties.login

string

Serveradministratörens inloggningsnamn.
properties.sid

string (uuid)

SID (objekt-ID) för serveradministratören.
properties.tenantId

string (uuid)

Administratörens klientorganisations-ID.
type

string

Resurstyp.