Servers - Get

  • 참조
Service:
SQL Database
API Version:
2021-11-01

서버를 가져옵니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
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

응답에 포함할 자식 리소스입니다.

응답

Name 형식 Description
200 OK

Server

지정된 서버를 성공적으로 검색했습니다.
Other Status Codes

오류 응답: ***

  • 404 SubscriptionNotFound - 요청된 구독을 찾을 수 없습니다.

  • 404 ResourceNotFound - 요청된 리소스를 찾을 수 없습니다.

예제

Get server
Get server with $expand=administrators/activedirectory

Get server

Sample Request

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

Sample Response

Status code:
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",
    "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

Sample Request

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

Sample Response

Status code:
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",
    "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"
          }
        }
      }
    ]
  }
}

정의

Name Description
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 관리자의 속성입니다.
ServerNetworkAccessFlag

이 서버에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다.
ServerPrivateEndpointConnection

서버 아래의 프라이빗 엔드포인트 연결
ServerWorkspaceFeature

기존 서버에 작업 영역이 만들어졌는지 여부 및 작업 영역에서의 연결을 허용하는지 여부
UserIdentity

리소스에 대한 Azure Active Directory ID 구성입니다.

AdministratorType

심각도 관리자의 유형입니다.

Name 형식 Description
ActiveDirectory

string

IdentityType

ID 형식입니다. 리소스에 대한 Azure Active Directory 보안 주체를 자동으로 만들고 할당하려면 이를 'SystemAssigned'로 설정합니다.

Name 형식 Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

PrincipalType

서버 관리자의 보안 주체 유형입니다.

Name 형식 Description
Application

string

Group

string

User

string

PrivateEndpointConnectionProperties

프라이빗 엔드포인트 연결의 속성입니다.

Name 형식 Description
groupIds

string[]

그룹 ID.
privateEndpoint

PrivateEndpointProperty

연결이 속한 프라이빗 엔드포인트입니다.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

프라이빗 엔드포인트 연결의 연결 상태입니다.
provisioningState

PrivateEndpointProvisioningState

프라이빗 엔드포인트 연결의 상태입니다.

PrivateEndpointProperty

Name 형식 Description
id

string

프라이빗 엔드포인트의 리소스 ID입니다.

PrivateEndpointProvisioningState

프라이빗 엔드포인트 연결의 상태입니다.

Name 형식 Description
Approving

string

Dropping

string

Failed

string

Ready

string

Rejecting

string

PrivateLinkServiceConnectionStateActionsRequire

프라이빗 링크 서비스 연결에 필요한 작업입니다.

Name 형식 Description
None

string

PrivateLinkServiceConnectionStateProperty

Name 형식 Description
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

프라이빗 링크 서비스 연결에 필요한 작업입니다.
description

string

프라이빗 링크 서비스 연결 설명입니다.
status

PrivateLinkServiceConnectionStateStatus

프라이빗 링크 서비스 연결 상태.

PrivateLinkServiceConnectionStateStatus

프라이빗 링크 서비스 연결 상태.

Name 형식 Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ResourceIdentity

리소스에 대한 Azure Active Directory ID 구성입니다.

Name 형식 Description
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 데이터베이스 서버입니다.

Name 형식 Description
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

이 서버에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다.
properties.restrictOutboundNetworkAccess

ServerNetworkAccessFlag

이 서버에 대한 아웃바운드 네트워크 액세스를 제한할지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다.
properties.state

string

서버의 상태입니다.
properties.version

string

서버의 버전입니다.
properties.workspaceFeature

ServerWorkspaceFeature

기존 서버에 작업 영역이 만들어졌는지 여부 및 작업 영역에서의 연결을 허용하는지 여부
tags

object

리소스 태그.
type

string

리소스 종류.

ServerExternalAdministrator

Active Directory 관리자의 속성입니다.

Name 형식 Description
administratorType

AdministratorType

심각도 관리자의 유형입니다.
azureADOnlyAuthentication

boolean

Azure Active Directory만 인증을 사용하도록 설정했습니다.
login

string

서버 관리자의 로그인 이름입니다.
principalType

PrincipalType

서버 관리자의 보안 주체 유형입니다.
sid

string

서버 관리자의 SID(개체 ID)입니다.
tenantId

string

관리자의 테넌트 ID입니다.

ServerNetworkAccessFlag

이 서버에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다.

Name 형식 Description
Disabled

string

Enabled

string

ServerPrivateEndpointConnection

서버 아래의 프라이빗 엔드포인트 연결

Name 형식 Description
id

string

리소스 ID입니다.
properties

PrivateEndpointConnectionProperties

프라이빗 엔드포인트 연결 속성

ServerWorkspaceFeature

기존 서버에 작업 영역이 만들어졌는지 여부 및 작업 영역에서의 연결을 허용하는지 여부

Name 형식 Description
Connected

string

Disconnected

string

UserIdentity

리소스에 대한 Azure Active Directory ID 구성입니다.

Name 형식 Description
clientId

string

Azure Active Directory 클라이언트 ID입니다.
principalId

string

Azure Active Directory 보안 주체 ID입니다.