Server Keys - List By Server

참조

서비스:: SQL Database

API 버전:: 2023-08-01

서버 키 목록을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스를 포함하는 리소스 그룹의 이름입니다. Azure Resource Manager API 또는 포털에서 이 값을 가져올 수 있습니다.
serverName	path	True	string	서버의 이름입니다.
subscriptionId	path	True	string	Azure 구독을 식별하는 구독 ID입니다.
api-version	query	True	string	요청에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	ServerKeyListResult	서버 키 목록을 성공적으로 검색했습니다.
Other Status Codes	ErrorResponse	오류 응답: *** 400 ManagedInstanceStoppingOrStopped - 인스턴스가 중지/중지된 상태인 동안 제출된 충돌 작업 400 ManagedInstanceStarting - 인스턴스가 시작 상태에 있는 동안 제출된 충돌 작업 400 InvalidKeyName - 서버 키 이름에 잘못된 값이 지정되었습니다. 400 InvalidKeyType - 서버 키 만들기 유형이 지원되지 않습니다. 400 InvalidUpsertKeyType - 서비스 관리 TDE 키는 서비스에서 관리됩니다. 서비스 관리형 TDE 키는 사용자에 의한 만들기 또는 업데이트를 지원하지 않습니다. 400 InvalidKeyUpsertRequest - 서버 키 만들기 요청이 없거나 속성 개체가 없습니다. 404 ServerNotInSubscriptionResourceGroup - 지정된 서버가 지정된 리소스 그룹 및 구독에 없습니다. 404 SubscriptionDoesNotHaveServer - 요청된 서버를 찾을 수 없습니다.

Name

형식

Description

200 OK

ServerKeyListResult

서버 키 목록을 성공적으로 검색했습니다.

Other Status Codes

ErrorResponse

오류 응답: ***

400 ManagedInstanceStoppingOrStopped - 인스턴스가 중지/중지된 상태인 동안 제출된 충돌 작업
400 ManagedInstanceStarting - 인스턴스가 시작 상태에 있는 동안 제출된 충돌 작업
400 InvalidKeyName - 서버 키 이름에 잘못된 값이 지정되었습니다.
400 InvalidKeyType - 서버 키 만들기 유형이 지원되지 않습니다.
400 InvalidUpsertKeyType - 서비스 관리 TDE 키는 서비스에서 관리됩니다. 서비스 관리형 TDE 키는 사용자에 의한 만들기 또는 업데이트를 지원하지 않습니다.
400 InvalidKeyUpsertRequest - 서버 키 만들기 요청이 없거나 속성 개체가 없습니다.
404 ServerNotInSubscriptionResourceGroup - 지정된 서버가 지정된 리소스 그룹 및 구독에 없습니다.
404 SubscriptionDoesNotHaveServer - 요청된 서버를 찾을 수 없습니다.

예제

List the server keys by server

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
        "creationDate": "2020-11-15T00:00:00Z",
        "autoRotationEnabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB",
        "creationDate": "2020-11-15T00:00:00Z",
        "autoRotationEnabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
ServerKey	서버 키입니다.
ServerKeyListResult	서버 키 목록입니다.
ServerKeyType	'ServiceManaged', 'AzureKeyVault'와 같은 서버 키 형식입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

ServerKey

Object

서버 키입니다.

Name	형식	Description
id	string	리소스 ID입니다.
kind	string	암호화 보호기의 종류입니다. Azure Portal 환경에 사용되는 메타데이터입니다.
location	string	리소스 위치입니다.
name	string	리소스 이름입니다.
properties.autoRotationEnabled	boolean	키 자동 회전 옵트인 플래그입니다. true 또는 false입니다.
properties.creationDate	string (date-time)	서버 키 생성 날짜입니다.
properties.serverKeyType	ServerKeyType	'ServiceManaged', 'AzureKeyVault'와 같은 서버 키 형식입니다.
properties.subregion	string	서버 키의 하위 리소스입니다.
properties.thumbprint	string	서버 키의 지문입니다.
properties.uri	string	서버 키의 URI입니다. ServerKeyType이 AzureKeyVault인 경우 URI가 필요합니다. AKV URI는 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' 형식이어야 합니다.
type	string	리소스 종류입니다.

ServerKeyListResult

Object

서버 키 목록입니다.

Name	형식	Description
nextLink	string	결과의 다음 페이지를 검색하는 링크입니다.
value	ServerKey[]	결과 배열입니다.

ServerKeyType

열거형

'ServiceManaged', 'AzureKeyVault'와 같은 서버 키 형식입니다.

값	Description
AzureKeyVault
ServiceManaged

다음을 통해 공유

Server Keys - List By Server

URI 매개 변수

응답

예제

List the server keys by server

샘플 요청

샘플 응답

정의

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerKey

ServerKeyListResult

ServerKeyType

추가 리소스