Servers - Get

Tjänst:: SQL Database

API-version:: 2025-01-01

Skaffar en server.

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

Med valfria parametrar:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?api-version=2025-01-01&$expand={$expand}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
$expand	query		string	De underordnade resurser som ska inkluderas i svaret.

Svar

Name	Typ	Description
200 OK	Server	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get server

Get server with $expand=administrators/activedirectory

Get server

Exempelbegäran

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645?api-version=2025-01-01

Exempelsvar

Statuskod:: 200

{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "kind": "v12.0",
  "location": "japaneast",
  "properties": {
    "administratorLogin": "dummylogin",
    "externalGovernanceStatus": "Enabled",
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "isIPv6Enabled": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "description": "Auto-approved",
            "actionsRequired": "None",
            "status": "Approved"
          },
          "provisioningState": "Ready"
        }
      }
    ],
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "retentionDays": 7,
    "state": "Ready",
    "version": "12.0",
    "workspaceFeature": "Connected"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

Get server with $expand=administrators/activedirectory

Exempelbegäran

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645?api-version=2025-01-01

Exempelsvar

Statuskod:: 200

{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "kind": "v12.0",
  "location": "japaneast",
  "properties": {
    "administratorLogin": "dummylogin",
    "administrators": {
      "azureADOnlyAuthentication": true,
      "login": "bob@contoso.com",
      "principalType": "User",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111"
    },
    "externalGovernanceStatus": "Enabled",
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "isIPv6Enabled": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "description": "Auto-approved",
            "actionsRequired": "None",
            "status": "Approved"
          },
          "provisioningState": "Ready"
        }
      }
    ],
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "retentionDays": 7,
    "state": "Ready",
    "version": "12.0",
    "workspaceFeature": "Connected"
  },
  "tags": {
    "tagKey1": "TagValue1"
  }
}

Definitioner

Name	Description
AdministratorType	Typ av administratör för serverservern.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Resurshanteringsfelet ytterligare information.
ErrorDetail	Detaljerna om felet.
ErrorResponse	Felsvar
ExternalGovernanceStatus	Status för extern styrning.
IdentityType	Identitetstypen. Ställ in detta till 'SystemAssigned' för att automatiskt skapa och tilldela en Azure Active Directory-princip för resursen.
MinimalTlsVersion	Minimal TLS-version. Tillåtna värden: "None", 1.0", "1.1", "1.2", "1.3"
PrincipalType	Huvudtyp för sever-administratören.
PrivateEndpointConnectionProperties	Egenskaper för en privat slutpunktsanslutning.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Tillståndet för den privata slutpunktsanslutningen.
PrivateLinkServiceConnectionStateActionsRequire	De åtgärder som krävs för privat länktjänstanslutning.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Anslutningsstatus för tjänsten private link.
ResourceIdentity	Azure Active Directory-identitetskonfiguration för en resurs.
Server	An Azure SQL Database server.
ServerCreateMode	Skapa läge för server, endast giltiga värden för detta är Normal och Återställ.
ServerExternalAdministrator	Egenskaper för en Active Directory-administratör.
ServerNetworkAccessFlag	Om du vill begränsa utgående nätverksåtkomst för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat"
ServerPrivateEndpointConnection	En privat slutpunktsanslutning under en server
ServerPublicNetworkAccessFlag	Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat" eller "SecuredByPerimeter"
ServerWorkspaceFeature	Om en befintlig server har skapat en arbetsyta eller inte och om den tillåter anslutning från arbetsytan
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserIdentity	Azure Active Directory-identitetskonfiguration för en resurs.

AdministratorType

Uppräkning

Typ av administratör för serverservern.

Värde	Description
ActiveDirectory	Active Directory

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

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.

ExternalGovernanceStatus

Uppräkning

Status för extern styrning.

Värde	Description
Enabled	Aktiverad
Disabled	Inaktiverad

IdentityType

Uppräkning

Identitetstypen. Ställ in detta till 'SystemAssigned' för att automatiskt skapa och tilldela en Azure Active Directory-princip för resursen.

Värde	Description
None	Ingen
SystemAssigned	Systemtilldelad
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemTilldelad, AnvändarTilldelad

MinimalTlsVersion

Uppräkning

Minimal TLS-version. Tillåtna värden: "None", 1.0", "1.1", "1.2", "1.3"

Värde	Description
None	Ingen
1.0	1.0
1.1	1.1
1.2	1.2
1.3	1.3

PrincipalType

Uppräkning

Huvudtyp för sever-administratören.

Värde	Description
User	User
Group	Grupp
Application	Ansökan

PrivateEndpointConnectionProperties

Objekt

Egenskaper för en privat slutpunktsanslutning.

Name	Typ	Description
groupIds	string[]	Grupp-ID:t.
privateEndpoint	PrivateEndpointProperty	Privat slutpunkt som anslutningen tillhör.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Anslutningstillstånd för den privata slutpunktsanslutningen.
provisioningState	PrivateEndpointProvisioningState	Tillståndet för den privata slutpunktsanslutningen.

PrivateEndpointProperty

Objekt

Name	Typ	Description
id	string	Resurs-ID för den privata slutpunkten.

PrivateEndpointProvisioningState

Uppräkning

Tillståndet för den privata slutpunktsanslutningen.

Värde	Description
Approving	Godkänner
Ready	Redo
Dropping	Släppa
Failed	Misslyckades
Rejecting	Avvisar

PrivateLinkServiceConnectionStateActionsRequire

Uppräkning

De åtgärder som krävs för privat länktjänstanslutning.

Värde	Description
None	Ingen

PrivateLinkServiceConnectionStateProperty

Objekt

Name	Typ	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	De åtgärder som krävs för privat länktjänstanslutning.
description	string	Beskrivning av tjänstanslutningen för privat länk.
status	PrivateLinkServiceConnectionStateStatus	Anslutningsstatus för tjänsten private link.

PrivateLinkServiceConnectionStateStatus

Uppräkning

Anslutningsstatus för tjänsten private link.

Värde	Description
Approved	Godkänd
Pending	Avvaktan
Rejected	Avvisad
Disconnected	Frånkopplad

ResourceIdentity

Objekt

Azure Active Directory-identitetskonfiguration för en resurs.

Name	Typ	Description
principalId	string (uuid)	Azure Active Directory principal id.
tenantId	string (uuid)	Azure Active Directory-tenant-id.
type	IdentityType	Identitetstypen. Ställ in detta till 'SystemAssigned' för att automatiskt skapa och tilldela en Azure Active Directory-princip för resursen.
userAssignedIdentities	<string, UserIdentity>	Resurs-ID:n för de användartilldelade identiteter som ska användas

Server

Objekt

An Azure SQL Database server.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ResourceIdentity	Serverns Azure Active Directory-identitet.
kind	string	Typ av SQL-server. Detta är metadata som används för Azure-portalupplevelsen.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.administratorLogin	string	Administratörsanvändarnamn för servern. När den har skapats kan den inte ändras.
properties.administratorLoginPassword	string (password)	Administratörens inloggningslösenord (krävs för att skapa servern).
properties.administrators	ServerExternalAdministrator	Azure Active Directory-administratören kan användas vid serverskapandet och för serveruppdateringar, förutom för egenskapen azureADOnlyAuthentication. Om du vill uppdatera egenskapen azureADOnlyAuthentication måste ett enskilt API användas.
properties.createMode	ServerCreateMode	Skapa läge för server, endast giltiga värden för detta är Normal och Återställ.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Status för extern styrning.
properties.federatedClientId	string (uuid)	Klient-ID:t som används för cmk-scenario mellan klientorganisationer
properties.fullyQualifiedDomainName	string	Serverns fullständigt kvalificerade domännamn.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Om du vill aktivera IPv6-stöd för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat"
properties.keyId	string	En CMK-URI för nyckeln som ska användas för kryptering.
properties.minimalTlsVersion	MinimalTlsVersion	Minimal TLS-version. Tillåtna värden: "None", 1.0", "1.1", "1.2", "1.3"
properties.primaryUserAssignedIdentityId	string	Resurs-ID för en användartilldelad identitet som ska användas som standard.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista över privata slutpunktsanslutningar på en server
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat" eller "SecuredByPerimeter"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Om du vill begränsa utgående nätverksåtkomst för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat"
properties.retentionDays	integer (int32)	Antal dagar som den här servern kommer att vara mjukt borttagen.
properties.state	string	Serverns tillstånd.
properties.version	string	Serverns version.
properties.workspaceFeature	ServerWorkspaceFeature	Om en befintlig server har skapat en arbetsyta eller inte och om den tillåter anslutning från arbetsytan
systemData	systemData	Azure Resource Manager-metadata som innehåller creationBy och modifiedBy-information.
tags	object	Resursetiketter.
type	string	Resurstypen. T.ex. "Microsoft. Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

ServerCreateMode

Uppräkning

Skapa läge för server, endast giltiga värden för detta är Normal och Återställ.

Värde	Description
Normal	Normal
Restore	Restore

ServerExternalAdministrator

Objekt

Egenskaper för en Active Directory-administratör.

Name	Typ	Description
administratorType	AdministratorType	Typ av administratör för serverservern.
azureADOnlyAuthentication	boolean	Azure Active Directory-endast autentisering aktiverad.
login	string	Serveradministratörens inloggningsnamn.
principalType	PrincipalType	Huvudtyp för sever-administratören.
sid	string (uuid)	SID (objekt-ID) för serveradministratören.
tenantId	string (uuid)	Administratörens klientorganisations-ID.

ServerNetworkAccessFlag

Uppräkning

Om du vill begränsa utgående nätverksåtkomst för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat"

Värde	Description
Enabled	Aktiverad
Disabled	Inaktiverad

ServerPrivateEndpointConnection

Objekt

En privat slutpunktsanslutning under en server

Name	Typ	Description
id	string	Resursidentifikator.
properties	PrivateEndpointConnectionProperties	Egenskaper för privat slutpunktsanslutning

ServerPublicNetworkAccessFlag

Uppräkning

Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat" eller "SecuredByPerimeter"

Värde	Description
Enabled	Aktiverad
Disabled	Inaktiverad
SecuredByPerimeter	Säkrad av perimeter

ServerWorkspaceFeature

Uppräkning

Om en befintlig server har skapat en arbetsyta eller inte och om den tillåter anslutning från arbetsytan

Värde	Description
Connected	Connected
Disconnected	Frånkopplad

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserIdentity

Objekt

Azure Active Directory-identitetskonfiguration för en resurs.

Name	Typ	Description
clientId	string (uuid)	Azure Active Directory-klient-id.
principalId	string (uuid)	Azure Active Directory principal id.

Dela via

Servers - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Get server

Exempelbegäran

Exempelsvar

Get server with $expand=administrators/activedirectory

Exempelbegäran

Exempelsvar

Definitioner

AdministratorType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerCreateMode

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

systemData

UserIdentity