Servers - List By Resource Group

リファレンス

Service:: SQL Database

API Version:: 2021-11-01

リソースグループ内のサーバーの一覧を取得します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。
$expand	query		string	応答に含める子リソース。

応答

名前	型	説明
200 OK	ServerListResult	サーバーの一覧が正常に取得されました。
Other Status Codes		エラー応答: *** 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

名前

型

説明

200 OK

ServerListResult

サーバーの一覧が正常に取得されました。

Other Status Codes

エラー応答: ***

404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。

例

List servers by resource group

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

List servers by resource group

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


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
Java

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


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"
              }
            }
          }
        ]
      }
    }
  ]
}

定義

名前	説明
AdministratorType	切断管理者の種類。
IdentityType	ID の種類。リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。
PrincipalType	サーバー管理者のプリンシパルの種類。
PrivateEndpointConnectionProperties	プライベートエンドポイント接続のプロパティ。
PrivateEndpointProperty
PrivateEndpointProvisioningState	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionStateActionsRequire	プライベートリンクサービス接続に必要なアクション。
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	プライベートリンクサービスの接続状態。
ResourceIdentity	リソースの Azure Active Directory ID 構成。
Server	Azure SQL データベースサーバー。
ServerExternalAdministrator	Active Directory 管理者のプロパティ。
ServerListResult	サーバーの一覧。
ServerNetworkAccessFlag	このサーバーに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります
ServerPrivateEndpointConnection	サーバー下のプライベートエンドポイント接続
ServerWorkspaceFeature	既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか
UserIdentity	リソースの Azure Active Directory ID 構成。

AdministratorType

切断管理者の種類。

名前	型	説明
ActiveDirectory	string

IdentityType

ID の種類。リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

サーバー管理者のプリンシパルの種類。

名前	型	説明
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

プライベートエンドポイント接続のプロパティ。

名前	型	説明
groupIds	string[]	グループ ID。
privateEndpoint	PrivateEndpointProperty	接続が属するプライベートエンドポイント。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	プライベートエンドポイント接続の接続状態。
provisioningState	PrivateEndpointProvisioningState	プライベートエンドポイント接続の状態。

PrivateEndpointProperty

名前	型	説明
id	string	プライベートエンドポイントのリソース ID。

PrivateEndpointProvisioningState

プライベートエンドポイント接続の状態。

名前	型	説明
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

プライベートリンクサービス接続に必要なアクション。

名前	型	説明
None	string

PrivateLinkServiceConnectionStateProperty

名前	型	説明
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	プライベートリンクサービス接続に必要なアクション。
description	string	プライベートリンクサービス接続の説明。
status	PrivateLinkServiceConnectionStateStatus	プライベートリンクサービスの接続状態。

PrivateLinkServiceConnectionStateStatus

プライベートリンクサービスの接続状態。

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

リソースの Azure Active Directory ID 構成。

名前	型	説明
principalId	string	Azure Active Directory プリンシパル ID。
tenantId	string	Azure Active Directory テナント ID。
type	IdentityType	ID の種類。リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。
userAssignedIdentities	<string, UserIdentity>	使用するユーザー割り当て ID のリソース ID

Server

Azure SQL データベースサーバー。

名前	型	説明
id	string	リソースの ID
identity	ResourceIdentity	サーバーの Azure Active Directory ID。
kind	string	SQL Server の種類。これは、Azure portal エクスペリエンスに使用されるメタデータです。
location	string	リソースの場所。
name	string	リソース名。
properties.administratorLogin	string	サーバーの管理者ユーザー名。作成後は変更できません。
properties.administratorLoginPassword	string	管理者ログインパスワード (サーバーの作成に必要)。
properties.administrators	ServerExternalAdministrator	サーバーの Azure Active Directory 管理者。
properties.federatedClientId	string	テナント間 CMK シナリオに使用されるクライアント ID
properties.fullyQualifiedDomainName	string	サーバーの完全修飾ドメイン名。
properties.keyId	string	暗号化に使用するキーの CMK URI。
properties.minimalTlsVersion	string	最小 TLS バージョン。使用できる値: '1.0'、'1.1'、'1.2'
properties.primaryUserAssignedIdentityId	string	既定で使用されるユーザー割り当て ID のリソース ID。
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	サーバー上のプライベートエンドポイント接続の一覧
properties.publicNetworkAccess	ServerNetworkAccessFlag	このサーバーに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	このサーバーの送信ネットワークアクセスを制限するかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります
properties.state	string	サーバーの状態。
properties.version	string	サーバーのバージョンです。
properties.workspaceFeature	ServerWorkspaceFeature	既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか
tags	object	リソースタグ。
type	string	リソースの種類。

ServerExternalAdministrator

Active Directory 管理者のプロパティ。

名前	型	説明
administratorType	AdministratorType	切断管理者の種類。
azureADOnlyAuthentication	boolean	Azure Active Directory のみ認証が有効になっています。
login	string	サーバー管理者のログイン名。
principalType	PrincipalType	サーバー管理者のプリンシパルの種類。
sid	string	サーバー管理者の SID (オブジェクト ID)。
tenantId	string	管理者のテナント ID。

ServerListResult

サーバーの一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	Server[]	結果の配列。

ServerNetworkAccessFlag

このサーバーに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります

名前	型	説明
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

サーバー下のプライベートエンドポイント接続

名前	型	説明
id	string	リソースの ID
properties	PrivateEndpointConnectionProperties	プライベートエンドポイント接続プロパティ

ServerWorkspaceFeature

既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか

名前	型	説明
Connected	string
Disconnected	string

UserIdentity

リソースの Azure Active Directory ID 構成。

名前	型	説明
clientId	string	Azure Active Directory クライアント ID。
principalId	string	Azure Active Directory プリンシパル ID。

Servers - List By Resource Group

URI パラメーター

応答

例

List servers by resource group

Sample Request

Sample Response

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

Sample Request

Sample Response

定義

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

その他のリソース