Servers - List

リファレンス

サービス:: SQL Database

API バージョン:: 2023-08-01

サブスクリプション内のすべてのサーバーの一覧を取得します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。
$expand	query		string	応答に含める子リソース。

応答

名前	型	説明
200 OK	ServerListResult	サーバーの一覧が正常に取得されました。
Other Status Codes	ErrorResponse	エラー応答: *** 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

名前

型

説明

200 OK

ServerListResult

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

Other Status Codes

ErrorResponse

エラー応答: ***

404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

List servers

List servers with $expand=administrators/activedirectory

List servers

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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 with $expand=administrators/activedirectory

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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	管理者の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ExternalGovernanceStatus	外部ガバナンスの状態。
IdentityType	ID の種類。リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。
MinimalTlsVersion	最小 TLS バージョン。使用できる値: 'None'、1.0'、'1.1'、'1.2'、'1.3'
PrincipalType	サーバー管理者のプリンシパルの種類。
PrivateEndpointConnectionProperties	プライベートエンドポイント接続のプロパティ。
PrivateEndpointProperty
PrivateEndpointProvisioningState	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionStateActionsRequire	プライベートリンクサービス接続に必要なアクション。
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	プライベートリンクサービスの接続状態。
ResourceIdentity	リソースの Azure Active Directory ID 構成。
Server	Azure SQL Database サーバー。
ServerExternalAdministrator	Active Directory 管理者のプロパティ。
ServerListResult	サーバーの一覧。
ServerNetworkAccessFlag	このサーバーの送信ネットワークアクセスを制限するかどうか。値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります
ServerPrivateEndpointConnection	サーバーの下のプライベートエンドポイント接続
ServerPublicNetworkAccessFlag	このサーバーに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' または 'SecuredByPerimeter' である必要があります
ServerWorkspaceFeature	既存のサーバーにワークスペースが作成されているかどうか、およびワークスペースからの接続が許可されているかどうか
UserIdentity	リソースの Azure Active Directory ID 構成。

AdministratorType

列挙

管理者の種類。

値	説明
ActiveDirectory

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ExternalGovernanceStatus

列挙

外部ガバナンスの状態。

値	説明
Disabled
Enabled

IdentityType

列挙

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

値	説明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

列挙

最小 TLS バージョン。使用できる値: 'None'、1.0'、'1.1'、'1.2'、'1.3'

値	説明
1.0
1.1
1.2
1.3
None

PrincipalType

列挙

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

値	説明
Application
Group
User

PrivateEndpointConnectionProperties

Object

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

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

PrivateEndpointProperty

Object

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

PrivateEndpointProvisioningState

列挙

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

値	説明
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

列挙

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

値	説明
None

PrivateLinkServiceConnectionStateProperty

Object

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

PrivateLinkServiceConnectionStateStatus

列挙

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

値	説明
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Object

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

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

Server

Object

Azure SQL Database サーバー。

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

ServerExternalAdministrator

Object

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

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

ServerListResult

Object

サーバーの一覧。

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

ServerNetworkAccessFlag

列挙

このサーバーの送信ネットワークアクセスを制限するかどうか。値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります

値	説明
Disabled
Enabled

ServerPrivateEndpointConnection

Object

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

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

ServerPublicNetworkAccessFlag

列挙

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

値	説明
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

列挙

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

値	説明
Connected
Disconnected

UserIdentity

Object

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

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

次の方法で共有

Servers - List

URI パラメーター

応答

例

List servers

要求のサンプル

応答のサンプル

List servers with $expand=administrators/activedirectory

要求のサンプル

応答のサンプル

定義

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity

その他のリソース