Product Subscriptions - List

  • 참조
Service:
API Management
API Version:
2022-08-01

지정된 제품에 대한 구독 컬렉션을 나열합니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI 매개 변수

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

string

제품 ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
resourceGroupName
 path True

string

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

string

API Management 서비스의 이름입니다.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

대상 구독의 ID입니다.
api-version
 query True

string

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

string

| 필드 | 사용량 | 지원되는 연산자 | 지원되는 함수 |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
$skip
 query

integer

int32

건너뛸 레코드의 수입니다.
$top
 query

integer

int32

반환할 레코드의 수입니다.

응답

Name 형식 Description
200 OK

SubscriptionCollection

구독 엔터티의 컬렉션을 나열합니다.
Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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 사용자 계정 가장

예제

ApiManagementListProductSubscriptions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002",
      "type": "Microsoft.ApiManagement/service/products/subscriptions",
      "name": "5600b57e7e8880006a070002",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002",
        "state": "active",
        "createdDate": "2015-09-22T01:57:18.723Z"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

정의

Name Description
ErrorFieldContract

오류 필드 계약.
ErrorResponse

오류 응답.
SubscriptionCollection

페이징된 구독 목록 표현입니다.
SubscriptionContract

구독 세부 정보.
SubscriptionState

구독 상태입니다. 가능한 상태는 * 활성 - 구독이 활성화됨, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 수행되었지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소되었습니다. * 만료됨 – 구독이 만료 날짜에 도달하여 비활성화되었습니다.

ErrorFieldContract

오류 필드 계약.

Name 형식 Description
code

string

속성 수준 오류 코드입니다.
message

string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target

string

속성 이름입니다.

ErrorResponse

오류 응답.

Name 형식 Description
error.code

string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details

ErrorFieldContract[]

유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다.
error.message

string

사람이 읽을 수 있는 오류 표현입니다.

SubscriptionCollection

페이징된 구독 목록 표현입니다.

Name 형식 Description
count

integer

모든 페이지의 총 레코드 수 번호입니다.
nextLink

string

다음 페이지 링크(있는 경우).
value

SubscriptionContract[]

페이지 값입니다.

SubscriptionContract

구독 세부 정보.

Name 형식 Description
id

string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

리소스의 이름입니다.
properties.allowTracing

boolean

추적을 사용할 수 있는지 여부를 확인합니다.
properties.createdDate

string

구독 만들기 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.displayName

string

구독의 이름이거나, 구독에 이름이 없는 경우 null입니다.
properties.endDate

string

구독이 취소되거나 만료된 날짜입니다. 이 설정은 감사 목적으로만 사용되며 구독은 자동으로 취소되지 않습니다. 속성을 사용하여 구독 수명 주기를 state 관리할 수 있습니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.expirationDate

string

구독 만료 날짜입니다. 설정은 감사 목적으로만 사용되며 구독이 자동으로 만료되지 않습니다. 속성을 사용하여 구독 수명 주기를 state 관리할 수 있습니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.notificationDate

string

예정된 구독 만료 알림 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.ownerId

string

구독 소유자의 사용자 리소스 식별자입니다. 값은 /users/{userId} 형식의 유효한 상대 URL입니다. 여기서 {userId}는 사용자 식별자입니다.
properties.primaryKey

string

구독 기본 키입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. 값을 얻으려면 '/listSecrets' POST 요청을 사용합니다.
properties.scope

string

/products/{productId} 또는 /api 또는 /apiId}와 같은 범위입니다.
properties.secondaryKey

string

구독 보조 키. 이 속성은 'GET' 작업에 채워지지 않습니다. 값을 얻으려면 '/listSecrets' POST 요청을 사용합니다.
properties.startDate

string

구독 활성화 날짜입니다. 설정은 감사 목적으로만 사용되며 구독은 자동으로 활성화되지 않습니다. 속성을 사용하여 구독 수명 주기를 state 관리할 수 있습니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.state

SubscriptionState

구독 상태입니다. 가능한 상태는 * 활성 - 구독이 활성화됨, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 수행되었지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소되었습니다. * 만료됨 – 구독이 만료 날짜에 도달하여 비활성화되었습니다.
properties.stateComment

string

상태가 '거부됨'으로 변경되면 관리자가 추가한 선택적 구독 주석입니다.
type

string

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

SubscriptionState

구독 상태입니다. 가능한 상태는 * 활성 - 구독이 활성화됨, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 수행되었지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소되었습니다. * 만료됨 – 구독이 만료 날짜에 도달하여 비활성화되었습니다.

Name 형식 Description
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string