共用方式為


Servers - List

取得訂用帳戶中所有伺服器的清單。

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

URI 參數

名稱 位於 必要 類型 Description
subscriptionId
path True

string

可識別 Azure 訂用帳戶的訂用帳戶識別碼。

api-version
query True

string

要用於要求的 API 版本。

$expand
query

string

要包含在回應中的子資源。

回應

名稱 類型 Description
200 OK

ServerListResult

已成功擷取伺服器清單。

Other Status Codes

錯誤回應: ≦

  • 404 SubscriptionNotFound - 找不到要求的訂用帳戶。

範例

List servers
List servers with $expand=administrators/activedirectory

List servers

範例要求

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

範例回覆

{
  "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

範例要求

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

範例回覆

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

定義

名稱 Description
AdministratorType

伺服器管理員的類型。

IdentityType

識別類型。 將此設定為 『SystemAssigned』,以便自動建立並指派資源的 Azure Active Directory 主體。

PrincipalType

伺服器管理員的主體類型。

PrivateEndpointConnectionProperties

私人端點連線的屬性。

PrivateEndpointProperty
PrivateEndpointProvisioningState

私人端點連線的狀態。

PrivateLinkServiceConnectionStateActionsRequire

私人鏈接服務連線所需的動作。

PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

私人鏈接服務連線狀態。

ResourceIdentity

資源的 Azure Active Directory 身分識別組態。

Server

Azure SQL 資料庫伺服器。

ServerExternalAdministrator

Active Directory 系統管理員的屬性。

ServerListResult

伺服器清單。

ServerNetworkAccessFlag

是否允許此伺服器的公用端點存取。 值是選擇性的,但如果傳入,則必須是 'Enabled' 或 'Disabled'

ServerPrivateEndpointConnection

伺服器下的私人端點連線

ServerWorkspaceFeature

現有伺服器是否已建立工作區,以及是否允許從工作區連線

UserIdentity

資源的 Azure Active Directory 身分識別組態。

AdministratorType

伺服器管理員的類型。

名稱 類型 Description
ActiveDirectory

string

IdentityType

識別類型。 將此設定為 『SystemAssigned』,以便自動建立並指派資源的 Azure Active Directory 主體。

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

PrincipalType

伺服器管理員的主體類型。

名稱 類型 Description
Application

string

Group

string

User

string

PrivateEndpointConnectionProperties

私人端點連線的屬性。

名稱 類型 Description
groupIds

string[]

群組標識碼。

privateEndpoint

PrivateEndpointProperty

線上所屬的私人端點。

privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

私人端點連線的連接狀態。

provisioningState

PrivateEndpointProvisioningState

私人端點連線的狀態。

PrivateEndpointProperty

名稱 類型 Description
id

string

私人端點的資源標識碼。

PrivateEndpointProvisioningState

私人端點連線的狀態。

名稱 類型 Description
Approving

string

Dropping

string

Failed

string

Ready

string

Rejecting

string

PrivateLinkServiceConnectionStateActionsRequire

私人鏈接服務連線所需的動作。

名稱 類型 Description
None

string

PrivateLinkServiceConnectionStateProperty

名稱 類型 Description
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

私人鏈接服務連線所需的動作。

description

string

私人鏈接服務連線描述。

status

PrivateLinkServiceConnectionStateStatus

私人鏈接服務連線狀態。

PrivateLinkServiceConnectionStateStatus

私人鏈接服務連線狀態。

名稱 類型 Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ResourceIdentity

資源的 Azure Active Directory 身分識別組態。

名稱 類型 Description
principalId

string

Azure Active Directory 主體標識符。

tenantId

string

Azure Active Directory 租用戶標識符。

type

IdentityType

識別類型。 將此設定為 『SystemAssigned』,以便自動建立並指派資源的 Azure Active Directory 主體。

userAssignedIdentities

<string,  UserIdentity>

要使用的使用者指派身分識別的資源標識碼

Server

Azure SQL 資料庫伺服器。

名稱 類型 Description
id

string

資源識別碼。

identity

ResourceIdentity

伺服器的 Azure Active Directory 身分識別。

kind

string

SQL Server 的種類。 這是用於 Azure 入口網站 體驗的元數據。

location

string

資源位置。

name

string

資源名稱。

properties.administratorLogin

string

伺服器的系統管理員用戶名稱。 建立之後,就無法變更。

properties.administratorLoginPassword

string

伺服器建立) 所需的系統管理員登入密碼 (。

properties.administrators

ServerExternalAdministrator

伺服器的 Azure Active Directory 系統管理員。

properties.federatedClientId

string

用於跨租使用者 CMK 案例的用戶端標識碼

properties.fullyQualifiedDomainName

string

伺服器的完整功能變數名稱。

properties.keyId

string

要用於加密之金鑰的 CMK URI。

properties.minimalTlsVersion

string

最低 TLS 版本。 允許的值:'1.0'、'1.1'、'1.2'

properties.primaryUserAssignedIdentityId

string

預設使用之使用者指派身分識別的資源標識碼。

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 系統管理員的屬性。

名稱 類型 Description
administratorType

AdministratorType

伺服器管理員的類型。

azureADOnlyAuthentication

boolean

僅啟用 Azure Active Directory 驗證。

login

string

伺服器管理員的登入名稱。

principalType

PrincipalType

伺服器管理員的主體類型。

sid

string

伺服器管理員) SID (物件識別碼。

tenantId

string

系統管理員的租用戶標識碼。

ServerListResult

伺服器清單。

名稱 類型 Description
nextLink

string

連結以擷取下一頁的結果。

value

Server[]

結果陣列。

ServerNetworkAccessFlag

是否允許此伺服器的公用端點存取。 值是選擇性的,但如果傳入,則必須是 'Enabled' 或 'Disabled'

名稱 類型 Description
Disabled

string

Enabled

string

ServerPrivateEndpointConnection

伺服器下的私人端點連線

名稱 類型 Description
id

string

資源識別碼。

properties

PrivateEndpointConnectionProperties

私人端點連線屬性

ServerWorkspaceFeature

現有伺服器是否已建立工作區,以及是否允許從工作區連線

名稱 類型 Description
Connected

string

Disconnected

string

UserIdentity

資源的 Azure Active Directory 身分識別組態。

名稱 類型 Description
clientId

string

Azure Active Directory 用戶端標識符。

principalId

string

Azure Active Directory 主體標識符。