Servers - List By Resource Group

Layanan:

SQL Database

Versi API:

2023-08-01

Mendapatkan daftar server dalam grup sumber daya.

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

Dengan parameter opsional:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers?$expand={$expand}&api-version=2023-08-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 API Azure Resource Manager atau portal.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang akan digunakan untuk permintaan tersebut.
$expand	query		string	Sumber daya anak untuk disertakan dalam respons.

Respons

Nama	Jenis	Deskripsi
200 OK	ServerListResult	Berhasil mengambil daftar server.
Other Status Codes	ErrorResponse	Respons Kesalahan: *** 404 SubscriptionNotFound - Langganan yang diminta tidak ditemukan. 429 SubscriptionTooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 503 TooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.

Contoh

List servers by resource group

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

List servers by resource group

Permintaan sampel

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerListByResourceGroup.json
// this example is just showing the usage of "Servers_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SqlServerResource
SqlServerCollection collection = resourceGroupResource.GetSqlServers();

// invoke the operation and iterate over the result
await foreach (SqlServerResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "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",
        "isIPv6Enabled": "Enabled",
        "externalGovernanceStatus": "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",
        "isIPv6Enabled": "Enabled",
        "externalGovernanceStatus": "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

Permintaan sampel

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerListByResourceGroupWithExpandEqualsAdministrators.json
// this example is just showing the usage of "Servers_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SqlServerResource
SqlServerCollection collection = resourceGroupResource.GetSqlServers();

// invoke the operation and iterate over the result
await foreach (SqlServerResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "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",
        "isIPv6Enabled": "Enabled",
        "externalGovernanceStatus": "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",
        "isIPv6Enabled": "Enabled",
        "externalGovernanceStatus": "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 sever.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ExternalGovernanceStatus	Status tata kelola eksternal.
IdentityType	Jenis identitas. Atur ini ke 'SystemAssigned' untuk membuat dan menetapkan prinsipal Azure Active Directory secara otomatis 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.
ServerExternalAdministrator	Properti administrator direktori aktif.
ServerListResult	Daftar server.
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
UserIdentity	Konfigurasi identitas Azure Active Directory untuk sumber daya.

AdministratorType

Enumeration

Jenis administrator sever.

Nilai	Deskripsi
ActiveDirectory

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[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ExternalGovernanceStatus

Enumeration

Status tata kelola eksternal.

Nilai	Deskripsi
Disabled
Enabled

IdentityType

Enumeration

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

Nilai	Deskripsi
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Enumeration

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

Nilai	Deskripsi
1.0
1.1
1.2
1.3
None

PrincipalType

Enumeration

Jenis Utama administrator sever.

Nilai	Deskripsi
Application
Group
User

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

Enumeration

Status koneksi titik akhir privat.

Nilai	Deskripsi
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeration

Tindakan yang diperlukan untuk koneksi layanan tautan privat.

Nilai	Deskripsi
None

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

Enumeration

Status koneksi layanan tautan privat.

Nilai	Deskripsi
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Objek

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama	Jenis	Deskripsi
principalId	string (uuid)	Id utama Azure Active Directory.
tenantId	string (uuid)	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

Objek

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 Microsoft 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. Ini hanya dapat digunakan pada waktu pembuatan server. Jika digunakan untuk pembaruan server, itu akan diabaikan atau akan mengakibatkan kesalahan. Untuk pembaruan masing-masing API perlu digunakan.
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.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
tags	object	Tag sumber daya.
type	string	Jenis sumber daya.

ServerExternalAdministrator

Objek

Properti administrator direktori aktif.

Nama	Jenis	Deskripsi
administratorType	AdministratorType	Jenis administrator sever.
azureADOnlyAuthentication	boolean	Azure Active Directory hanya Autentikasi yang 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.

ServerListResult

Objek

Daftar server.

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

ServerNetworkAccessFlag

Enumeration

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

Nilai	Deskripsi
Disabled
Enabled

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

Enumeration

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
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

Enumeration

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

Nilai	Deskripsi
Connected
Disconnected

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 utama Azure Active Directory.