Gateway - List Keys
게이트웨이 키를 검색합니다.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2022-08-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다. |
resource
|
path | True |
string |
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다. |
service
|
path | True |
string |
API Management 서비스의 이름입니다. Regex pattern: |
subscription
|
path | True |
string |
대상 구독의 ID입니다. |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
응답 본문에는 지정된 게이트웨이 키가 포함됩니다. Headers ETag: string |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
ApiManagementGatewayListKeys
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2022-08-01
Sample Response
{
"primary": "primary_key_value",
"secondary": "secondary_key_value"
}
정의
Name | Description |
---|---|
Error |
오류 필드 계약입니다. |
Error |
오류 응답. |
Gateway |
게이트웨이 인증 키. |
ErrorFieldContract
오류 필드 계약입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
속성 수준 오류 코드입니다. |
message |
string |
사람이 읽을 수 있는 속성 수준 오류 표현입니다. |
target |
string |
속성 이름입니다. |
ErrorResponse
오류 응답.
Name | 형식 | Description |
---|---|---|
error.code |
string |
서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다. |
error.details |
유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다. |
|
error.message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
GatewayKeysContract
게이트웨이 인증 키.
Name | 형식 | Description |
---|---|---|
primary |
string |
기본 게이트웨이 키입니다. |
secondary |
string |
보조 게이트웨이 키. |