你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Servers - Get

获取服务器。

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

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serverName
path True

string

服务器的名称。

subscriptionId
path True

string

用于标识 Azure 订阅的订阅 ID。

api-version
query True

string

要用于请求的 API 版本。

$expand
query

string

要包含在响应中的子资源。

响应

名称 类型 说明
200 OK

Server

已成功检索指定的服务器。

Other Status Codes

错误响应:***

  • 404 SubscriptionNotFound - 找不到请求的订阅。

  • 404 ResourceNotFound - 找不到请求的资源。

示例

Get server
Get server with $expand=administrators/activedirectory

Get server

示例请求

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

示例响应

{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "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"
          }
        }
      }
    ]
  }
}

Get server with $expand=administrators/activedirectory

示例请求

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

示例响应

{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "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"
          }
        }
      }
    ]
  }
}

定义

名称 说明
AdministratorType

服务器管理员的类型。

IdentityType

标识类型。 将其设置为“SystemAssigned”,以便自动为资源创建和分配 Azure Active Directory 主体。

PrincipalType

服务器管理员的主体类型。

PrivateEndpointConnectionProperties

专用终结点连接的属性。

PrivateEndpointProperty
PrivateEndpointProvisioningState

专用终结点连接的状态。

PrivateLinkServiceConnectionStateActionsRequire

专用链接服务连接所需的操作。

PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

专用链接服务连接状态。

ResourceIdentity

资源的 Azure Active Directory 标识配置。

Server

Azure SQL数据库服务器。

ServerExternalAdministrator

Active Directory 管理员的属性。

ServerNetworkAccessFlag

是否允许此服务器访问公共终结点。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”

ServerPrivateEndpointConnection

服务器下的专用终结点连接

ServerWorkspaceFeature

现有服务器是否创建了工作区,以及是否允许从工作区进行连接

UserIdentity

资源的 Azure Active Directory 标识配置。

AdministratorType

服务器管理员的类型。

名称 类型 说明
ActiveDirectory

string

IdentityType

标识类型。 将其设置为“SystemAssigned”,以便自动为资源创建和分配 Azure Active Directory 主体。

名称 类型 说明
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 标识配置。

名称 类型 说明
principalId

string

Azure Active Directory 主体 ID。

tenantId

string

Azure Active Directory 租户 ID。

type

IdentityType

标识类型。 将其设置为“SystemAssigned”,以便自动为资源创建和分配 Azure Active Directory 主体。

userAssignedIdentities

<string,  UserIdentity>

要使用的用户分配标识的资源 ID

Server

Azure SQL数据库服务器。

名称 类型 说明
id

string

资源 ID。

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 方案的客户端 ID

properties.fullyQualifiedDomainName

string

服务器的完全限定域名。

properties.keyId

string

要用于加密的密钥的 CMK URI。

properties.minimalTlsVersion

string

最低 TLS 版本。 允许的值:“1.0”、“1.1”、“1.2”

properties.primaryUserAssignedIdentityId

string

默认要使用的用户分配标识的资源 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。

ServerNetworkAccessFlag

是否允许此服务器访问公共终结点。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”

名称 类型 说明
Disabled

string

Enabled

string

ServerPrivateEndpointConnection

服务器下的专用终结点连接

名称 类型 说明
id

string

资源 ID。

properties

PrivateEndpointConnectionProperties

专用终结点连接属性

ServerWorkspaceFeature

现有服务器是否创建了工作区,以及是否允许从工作区进行连接

名称 类型 说明
Connected

string

Disconnected

string

UserIdentity

资源的 Azure Active Directory 标识配置。

名称 类型 说明
clientId

string

Azure Active Directory 客户端 ID。

principalId

string

Azure Active Directory 主体 ID。