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

Servers - Get

服务:: SQL Database

API 版本:: 2023-08-01

获取服务器。

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

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?$expand={$expand}&api-version=2023-08-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	ErrorResponse	错误响应： *** 404 SubscriptionNotFound - 找不到请求的订阅。 404 ResourceNotFound - 找不到请求的资源。 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

名称

类型

说明

200 OK

Server

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

Other Status Codes

ErrorResponse

错误响应： ***

404 SubscriptionNotFound - 找不到请求的订阅。
404 ResourceNotFound - 找不到请求的资源。
429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。
503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

示例

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=2023-08-01

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerGet.json
// this example is just showing the usage of "Servers_Get" 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://free.blessedness.top/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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// invoke the operation
SqlServerResource result = await sqlServer.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

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

Get server with $expand=administrators/activedirectory

示例请求

HTTP
dotnet

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

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerGetWithExpandEqualsAdministrators.json
// this example is just showing the usage of "Servers_Get" 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://free.blessedness.top/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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// invoke the operation
SqlServerResource result = await sqlServer.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

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

定义

名称	说明
AdministratorType	服务器管理员的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExternalGovernanceStatus	外部治理的状态。
IdentityType	标识类型。将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。
MinimalTlsVersion	最低 TLS 版本。允许的值：“None”、“1.0”、“1.1”、“1.2”、“1.3”
PrincipalType	服务器管理员的主体类型。
PrivateEndpointConnectionProperties	专用终结点连接的属性。
PrivateEndpointProperty
PrivateEndpointProvisioningState	专用终结点连接的状态。
PrivateLinkServiceConnectionStateActionsRequire	专用链接服务连接所需的作。
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	专用链接服务连接状态。
ResourceIdentity	资源的 Azure Active Directory 标识配置。
Server	Azure SQL 数据库服务器。
ServerExternalAdministrator	Active Directory 管理员的属性。
ServerNetworkAccessFlag	是否限制此服务器的出站网络访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”
ServerPrivateEndpointConnection	服务器下的专用终结点连接
ServerPublicNetworkAccessFlag	是否允许对此服务器使用公共终结点访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”或“SecuredByPerimeter”
ServerWorkspaceFeature	现有服务器是否创建了工作区，以及是否允许从工作区进行连接
UserIdentity	资源的 Azure Active Directory 标识配置。

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

枚举

外部治理的状态。

值	说明
Enabled
Disabled

IdentityType

枚举

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

值	说明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MinimalTlsVersion

枚举

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

值	说明
None
1.0
1.1
1.2
1.3

PrincipalType

枚举

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

值	说明
User
Group
Application

PrivateEndpointConnectionProperties

Object

专用终结点连接的属性。

名称	类型	说明
groupIds	string[]	组 ID。
privateEndpoint	PrivateEndpointProperty	连接所属的专用终结点。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。
provisioningState	PrivateEndpointProvisioningState	专用终结点连接的状态。

PrivateEndpointProperty

Object

名称	类型	说明
id	string	专用终结点的资源 ID。

PrivateEndpointProvisioningState

枚举

专用终结点连接的状态。

值	说明
Approving
Ready
Dropping
Failed
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

枚举

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

值	说明
None

PrivateLinkServiceConnectionStateProperty

Object

名称	类型	说明
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	专用链接服务连接所需的作。
description	string	专用链接服务连接说明。
status	PrivateLinkServiceConnectionStateStatus	专用链接服务连接状态。

PrivateLinkServiceConnectionStateStatus

枚举

专用链接服务连接状态。

值	说明
Approved
Pending
Rejected
Disconnected

ResourceIdentity

Object

资源的 Azure Active Directory 标识配置。

名称	类型	说明
principalId	string (uuid)	Azure Active Directory 主体 ID。
tenantId	string (uuid)	Azure Active Directory 租户 ID。
type	IdentityType	标识类型。将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。
userAssignedIdentities	<string, UserIdentity>	要使用的用户分配标识的资源 ID

Server

Object

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 管理员。这只能在服务器创建时使用。如果用于服务器更新，将忽略它，否则将导致错误。对于各个 API 的更新，需要使用这些 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。
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。

ServerNetworkAccessFlag

枚举

是否限制此服务器的出站网络访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”

值	说明
Enabled
Disabled

ServerPrivateEndpointConnection

Object

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

名称	类型	说明
id	string	资源 ID。
properties	PrivateEndpointConnectionProperties	专用终结点连接属性

ServerPublicNetworkAccessFlag

枚举

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

值	说明
Enabled
Disabled
SecuredByPerimeter

ServerWorkspaceFeature

枚举

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

值	说明
Connected
Disconnected

UserIdentity

Object

资源的 Azure Active Directory 标识配置。

名称	类型	说明
clientId	string (uuid)	Azure Active Directory 客户端 ID。
principalId	string (uuid)	Azure Active Directory 主体 ID。

通过

Servers - Get

URI 参数

响应

示例

Get server

示例请求

示例响应

Get server with $expand=administrators/activedirectory

示例请求

示例响应

定义

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity