Workspaces - List Keys

서비스:
Azure Quantum
API 버전:
2025-12-15-preview

Quantum API와 함께 사용할 키를 가져옵니다. 키는 Quantum REST API에 대한 액세스를 인증하고 권한을 부여하는 데 사용됩니다. 한 번에 하나의 키만 필요합니다. 원활한 키 다시 생성을 제공하기 위해 두 가지가 제공됩니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys?api-version=2025-12-15-preview

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
subscriptionId
 path True

string (uuid)

대상 구독의 ID입니다. 값은 UUID여야 합니다.
workspaceName
 path True

string

pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$

양자 작업 영역 리소스의 이름입니다.
api-version
 query True

string

minLength: 1

이 작업에 사용할 API 버전입니다.

응답

Name 형식 Description
200 OK

ListKeysResult

Azure 작업이 성공적으로 완료되었습니다.
Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

Workspaces_ListKeys

샘플 요청

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/workspaces/quantumworkspace1/listKeys?api-version=2025-12-15-preview

샘플 응답

상태 코드:
200 
{
  "apiKeyEnabled": true,
  "primaryKey": {
    "createdAt": "2023-11-13T23:06:09.147165Z",
    "key": "<primaryKey>"
  },
  "secondaryKey": {
    "createdAt": "2023-11-13T23:06:09.147165Z",
    "key": "<secondaryKey>"
  },
  "primaryConnectionString": "<primaryConnectionString>",
  "secondaryConnectionString": "<secondaryConnectionString>"
}

정의

Name Description
ApiKey

Azure quantum 작업 영역 API 키 세부 정보입니다.
ErrorAdditionalInfo

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

오류 세부 정보입니다.
ErrorResponse

오류 응답
ListKeysResult

목록 API 키 및 연결 문자열의 결과입니다.

ApiKey

Object

Azure quantum 작업 영역 API 키 세부 정보입니다.

Name 형식 Description
createdAt

string (date-time)

API 키의 생성 시간입니다.
key

string

API 키입니다.

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

오류 개체입니다.

ListKeysResult

Object

목록 API 키 및 연결 문자열의 결과입니다.

Name 형식 Description
apiKeyEnabled

boolean

Quantum 작업 영역 API 키의 사용 표시기입니다.
primaryConnectionString

string

기본 API 키의 연결 문자열입니다.
primaryKey

ApiKey

양자 작업 영역 기본 API 키입니다.
secondaryConnectionString

string

보조 API 키의 연결 문자열입니다.
secondaryKey

ApiKey

양자 작업 영역 보조 API 키입니다.