Servers - Get

Layanan:: SQL Database

Versi API:: 2025-01-01

Mengakses server.

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
serverName	path	True	string	Nama server.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
$expand	query		string	Sumber daya anak untuk disertakan dalam respons.

Respons

Nama	Jenis	Deskripsi
200 OK	Server	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get server

Get server with $expand=administrators/activedirectory

Get server

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

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/SQL/stable/2025-01-01/examples/ServerGet.json
// this example is just showing the usage of "Servers_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-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// invoke the operation
SqlServerResource result = await sqlServer.GetAsync();

// 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
SqlServerData 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

Respon sampel

Kode status:: 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

Permintaan sampel

HTTP
dotnet

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

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/SQL/stable/2025-01-01/examples/ServerGetWithExpandEqualsAdministrators.json
// this example is just showing the usage of "Servers_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-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// invoke the operation
SqlServerResource result = await sqlServer.GetAsync();

// 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
SqlServerData 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

Respon sampel

Kode status:: 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"
  }
}

Definisi

Nama	Deskripsi
AdministratorType	Jenis administrator sever.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
ExternalGovernanceStatus	Status tata kelola eksternal.
IdentityType	Jenis identitas. Atur ini ke 'SystemAssigned' untuk secara otomatis membuat dan menetapkan perwakilan Azure Active Directory untuk sumber daya.
MinimalTlsVersion	Versi TLS minimal. Nilai yang diizinkan: 'None', 1.0', '1.1', '1.2', '1.3'
PrincipalType	Jenis Utama administrator sever.
PrivateEndpointConnectionProperties	Properti koneksi titik akhir privat.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Status koneksi titik akhir privat.
PrivateLinkServiceConnectionStateActionsRequire	Tindakan yang diperlukan untuk koneksi layanan tautan privat.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Status koneksi layanan tautan privat.
ResourceIdentity	Konfigurasi identitas Azure Active Directory untuk sumber daya.
Server	Server Azure SQL Database.
ServerCreateMode	Buat mode untuk server, hanya nilai yang valid untuk ini adalah Normal dan Pulihkan.
ServerExternalAdministrator	Properti administrator direktori aktif.
ServerNetworkAccessFlag	Apakah membatasi akses jaringan keluar untuk server ini atau tidak. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'
ServerPrivateEndpointConnection	Koneksi titik akhir privat di bawah server
ServerPublicNetworkAccessFlag	Apakah akses titik akhir publik diizinkan atau tidak untuk server ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan' atau 'SecuredByPerimeter'
ServerWorkspaceFeature	Apakah server yang ada dibuat atau tidak memiliki ruang kerja dan apakah memungkinkan koneksi dari ruang kerja
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserIdentity	Konfigurasi identitas Azure Active Directory untuk sumber daya.

AdministratorType

Enumerasi

Jenis administrator sever.

Nilai	Deskripsi
ActiveDirectory	Direktori Aktif

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ExternalGovernanceStatus

Enumerasi

Status tata kelola eksternal.

Nilai	Deskripsi
Enabled	Enabled
Disabled	Nonaktif

IdentityType

Enumerasi

Jenis identitas. Atur ini ke 'SystemAssigned' untuk secara otomatis membuat dan menetapkan perwakilan Azure Active Directory untuk sumber daya.

Nilai	Deskripsi
None	Tidak
SystemAssigned	DitugaskanSistem
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SistemTugas,Pengguna Ditetapkan

MinimalTlsVersion

Enumerasi

Versi TLS minimal. Nilai yang diizinkan: 'None', 1.0', '1.1', '1.2', '1.3'

Nilai	Deskripsi
None	Tidak
1.0	1.0
1.1	1.1
1.2	1.2
1.3	1.3

PrincipalType

Enumerasi

Jenis Utama administrator sever.

Nilai	Deskripsi
User	Pengguna
Group	Kelompok
Application	Application

PrivateEndpointConnectionProperties

Objek

Properti koneksi titik akhir privat.

Nama	Jenis	Deskripsi
groupIds	string[]	ID Grup.
privateEndpoint	PrivateEndpointProperty	Titik akhir privat tempat koneksi berada.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Status koneksi koneksi titik akhir privat.
provisioningState	PrivateEndpointProvisioningState	Status koneksi titik akhir privat.

PrivateEndpointProperty

Objek

Nama	Jenis	Deskripsi
id	string	Id sumber daya titik akhir privat.

PrivateEndpointProvisioningState

Enumerasi

Status koneksi titik akhir privat.

Nilai	Deskripsi
Approving	Menyetujui
Ready	Siap
Dropping	Menjatuhkan
Failed	Kegagalan
Rejecting	Menolak

PrivateLinkServiceConnectionStateActionsRequire

Enumerasi

Tindakan yang diperlukan untuk koneksi layanan tautan privat.

Nilai	Deskripsi
None	Tidak

PrivateLinkServiceConnectionStateProperty

Objek

Nama	Jenis	Deskripsi
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Tindakan yang diperlukan untuk koneksi layanan tautan privat.
description	string	Deskripsi koneksi layanan tautan privat.
status	PrivateLinkServiceConnectionStateStatus	Status koneksi layanan tautan privat.

PrivateLinkServiceConnectionStateStatus

Enumerasi

Status koneksi layanan tautan privat.

Nilai	Deskripsi
Approved	Disetujui
Pending	Menunggu
Rejected	Ditolak
Disconnected	Terputus

ResourceIdentity

Objek

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama	Jenis	Deskripsi
principalId	string (uuid)	ID perwakilan Azure Active Directory.
tenantId	string (uuid)	ID penyewa Azure Active Directory.
type	IdentityType	Jenis identitas. Atur ini ke 'SystemAssigned' untuk secara otomatis membuat dan menetapkan perwakilan Azure Active Directory untuk sumber daya.
userAssignedIdentities	<string, UserIdentity>	Id sumber daya dari identitas yang ditetapkan pengguna untuk digunakan

Server

Objek

Server Azure SQL Database.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ResourceIdentity	Identitas Azure Active Directory server.
kind	string	Jenis server sql. Ini adalah metadata yang digunakan untuk pengalaman portal Azure.
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.administratorLogin	string	Nama pengguna administrator untuk server. Setelah dibuat, itu tidak dapat diubah.
properties.administratorLoginPassword	string (password)	Kata sandi masuk administrator (diperlukan untuk pembuatan server).
properties.administrators	ServerExternalAdministrator	Administrator Azure Active Directory dapat digunakan selama pembuatan server dan untuk pembaruan server, kecuali untuk properti azureADOnlyAuthentication. Untuk memperbarui properti azureADOnlyAuthentication, API individual harus digunakan.
properties.createMode	ServerCreateMode	Buat mode untuk server, hanya nilai yang valid untuk ini adalah Normal dan Pulihkan.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Status tata kelola eksternal.
properties.federatedClientId	string (uuid)	Id Klien yang digunakan untuk skenario CMK lintas penyewa
properties.fullyQualifiedDomainName	string	Nama domain server yang sepenuhnya memenuhi syarat.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Apakah mengaktifkan dukungan IPv6 untuk server ini atau tidak. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'
properties.keyId	string	URI CMK kunci yang akan digunakan untuk enkripsi.
properties.minimalTlsVersion	MinimalTlsVersion	Versi TLS minimal. Nilai yang diizinkan: 'None', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId	string	Id sumber daya identitas yang ditetapkan pengguna yang akan digunakan secara default.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Daftar koneksi titik akhir privat di server
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Apakah akses titik akhir publik diizinkan atau tidak untuk server ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan' atau 'SecuredByPerimeter'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Apakah membatasi akses jaringan keluar untuk server ini atau tidak. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'
properties.retentionDays	integer (int32)	Jumlah hari server ini akan tetap dihapus sementara.
properties.state	string	Status server.
properties.version	string	Versi server.
properties.workspaceFeature	ServerWorkspaceFeature	Apakah server yang ada dibuat atau tidak memiliki ruang kerja dan apakah memungkinkan koneksi dari ruang kerja
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya "Microsoft. Komputasi/virtualMachines" atau "Microsoft. Akun penyimpanan/penyimpanan"

ServerCreateMode

Enumerasi

Buat mode untuk server, hanya nilai yang valid untuk ini adalah Normal dan Pulihkan.

Nilai	Deskripsi
Normal	Biasa
Restore	Restore

ServerExternalAdministrator

Objek

Properti administrator direktori aktif.

Nama	Jenis	Deskripsi
administratorType	AdministratorType	Jenis administrator sever.
azureADOnlyAuthentication	boolean	Hanya Azure Active Directory Autentikasi diaktifkan.
login	string	Nama masuk administrator server.
principalType	PrincipalType	Jenis Utama administrator sever.
sid	string (uuid)	SID (ID objek) administrator server.
tenantId	string (uuid)	ID penyewa administrator.

ServerNetworkAccessFlag

Enumerasi

Apakah membatasi akses jaringan keluar untuk server ini atau tidak. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'

Nilai	Deskripsi
Enabled	Enabled
Disabled	Nonaktif

ServerPrivateEndpointConnection

Objek

Koneksi titik akhir privat di bawah server

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
properties	PrivateEndpointConnectionProperties	Properti koneksi titik akhir privat

ServerPublicNetworkAccessFlag

Enumerasi

Apakah akses titik akhir publik diizinkan atau tidak untuk server ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan' atau 'SecuredByPerimeter'

Nilai	Deskripsi
Enabled	Enabled
Disabled	Nonaktif
SecuredByPerimeter	Diamankan olehPerimeter

ServerWorkspaceFeature

Enumerasi

Apakah server yang ada dibuat atau tidak memiliki ruang kerja dan apakah memungkinkan koneksi dari ruang kerja

Nilai	Deskripsi
Connected	Tersambung
Disconnected	Terputus

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

UserIdentity

Objek

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama	Jenis	Deskripsi
clientId	string (uuid)	ID klien Azure Active Directory.
principalId	string (uuid)	ID perwakilan Azure Active Directory.