Servers - List By Resource Group

Service:

SQL Database

API Version:

2021-11-01

Mendapatkan daftar server dalam grup sumber daya.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang digunakan untuk permintaan.
$expand	query		string	Sumber daya anak yang akan disertakan dalam respons.

Respons

Nama	Jenis	Deskripsi
200 OK	ServerListResult	Berhasil mengambil daftar server.
Other Status Codes		Respons Kesalahan: *** 404 SubscriptionNotFound - Langganan yang diminta tidak ditemukan.

Contoh

List servers by resource group

List servers by resource group with $expand=administrators/activedirectory

List servers by resource group

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for Servers ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerListByResourceGroup.json
     */
    /**
     * Sample code: List servers by resource group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listServersByResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().listByResourceGroup("sqlcrudtest-7398", null,
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

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

List servers by resource group with $expand=administrators/activedirectory

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for Servers ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ServerListByResourceGroupWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: List servers by resource group with $expand=administrators/activedirectory.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listServersByResourceGroupWithExpandAdministratorsActivedirectory(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().listByResourceGroup("sqlcrudtest-7398", null,
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

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

Definisi

Nama	Deskripsi
AdministratorType	Jenis administrator server.
IdentityType	Jenis identitas. Atur ini ke 'SystemAssigned' untuk membuat dan menetapkan prinsipal Azure Active Directory secara otomatis untuk sumber daya.
PrincipalType	Jenis Utama administrator server.
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.
ServerExternalAdministrator	Properti administrator direktori aktif.
ServerListResult	Daftar server.
ServerNetworkAccessFlag	Apakah akses titik akhir publik diperbolehkan untuk server ini atau tidak. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'
ServerPrivateEndpointConnection	Koneksi titik akhir privat di bawah server
ServerWorkspaceFeature	Apakah server yang ada memiliki ruang kerja yang dibuat atau tidak dan apakah memungkinkan koneksi dari ruang kerja atau tidak
UserIdentity	Konfigurasi identitas Azure Active Directory untuk sumber daya.

AdministratorType

Jenis administrator server.

Nama	Jenis	Deskripsi
ActiveDirectory	string

IdentityType

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

Nama	Jenis	Deskripsi
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

Jenis Utama administrator server.

Nama	Jenis	Deskripsi
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

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

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

PrivateEndpointProvisioningState

Status koneksi titik akhir privat.

Nama	Jenis	Deskripsi
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Tindakan yang diperlukan untuk koneksi layanan tautan privat.

Nama	Jenis	Deskripsi
None	string

PrivateLinkServiceConnectionStateProperty

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

Status koneksi layanan tautan privat.

Nama	Jenis	Deskripsi
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

Konfigurasi identitas Azure Active Directory untuk sumber daya.

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

Server

Server Azure SQL Database.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
identity	ResourceIdentity	Identitas Azure Active Directory server.
kind	string	Jenis server sql. Ini adalah metadata yang digunakan untuk pengalaman portal Azure.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.administratorLogin	string	Nama pengguna administrator untuk server. Setelah dibuat, itu tidak dapat diubah.
properties.administratorLoginPassword	string	Kata sandi masuk administrator (diperlukan untuk pembuatan server).
properties.administrators	ServerExternalAdministrator	Administrator Azure Active Directory server.
properties.federatedClientId	string	Id Klien yang digunakan untuk skenario CMK lintas penyewa
properties.fullyQualifiedDomainName	string	Nama domain server yang sepenuhnya memenuhi syarat.
properties.keyId	string	URI CMK kunci yang digunakan untuk enkripsi.
properties.minimalTlsVersion	string	Versi TLS minimal. Nilai yang diizinkan: '1.0', '1.1', '1.2'
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	ServerNetworkAccessFlag	Apakah akses titik akhir publik diperbolehkan untuk server ini atau tidak. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Apakah akan membatasi akses jaringan keluar untuk server ini atau tidak. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'
properties.state	string	Status server.
properties.version	string	Versi server.
properties.workspaceFeature	ServerWorkspaceFeature	Apakah server yang ada memiliki ruang kerja yang dibuat atau tidak dan apakah memungkinkan koneksi dari ruang kerja atau tidak
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

ServerExternalAdministrator

Properti administrator direktori aktif.

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

ServerListResult

Daftar server.

Nama	Jenis	Deskripsi
nextLink	string	Tautan untuk mengambil halaman hasil berikutnya.
value	Server[]	Array hasil.

ServerNetworkAccessFlag

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

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

Koneksi titik akhir privat di bawah server

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

ServerWorkspaceFeature

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

Nama	Jenis	Deskripsi
Connected	string
Disconnected	string

UserIdentity

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama	Jenis	Deskripsi
clientId	string	Id klien Azure Active Directory.
principalId	string	Id utama Azure Active Directory.