다음을 통해 공유

SubscriptionContract interface

  • 참조
패키지:
@azure/arm-apimanagement

구독 세부 정보.

Extends
ProxyResource

속성

allowTracing

추적을 사용할 수 있는지 여부를 결정합니다.
createdDate

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

참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
displayName

구독의 이름 또는 구독에 이름이 없는 경우 null입니다.
endDate

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

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

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

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

구독 기본 키입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.
scope

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

구독 보조 키입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.
startDate

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

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

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

상속된 속성

id

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
name

리소스의 이름 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
type

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

속성 세부 정보

allowTracing

추적을 사용할 수 있는지 여부를 결정합니다.

allowTracing?: boolean

속성 값

boolean

createdDate

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

참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

createdDate?: Date

속성 값

Date

displayName

구독의 이름 또는 구독에 이름이 없는 경우 null입니다.

displayName?: string

속성 값

string

endDate

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

endDate?: Date

속성 값

Date

expirationDate

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

expirationDate?: Date

속성 값

Date

notificationDate

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

notificationDate?: Date

속성 값

Date

ownerId

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

ownerId?: string

속성 값

string

primaryKey

구독 기본 키입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.

primaryKey?: string

속성 값

string

scope

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

scope?: string

속성 값

string

secondaryKey

구독 보조 키입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.

secondaryKey?: string

속성 값

string

startDate

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

startDate?: Date

속성 값

Date

state

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

state?: SubscriptionState

속성 값

SubscriptionState

stateComment

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

stateComment?: string

속성 값

string

상속된 속성 세부 정보

id

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

id?: string

속성 값

string

상속된ProxyResource.id

name

리소스의 이름 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

name?: string

속성 값

string

ProxyResource.name 상속됨

type

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

type?: string

속성 값

string

ProxyResource.type에서 상속됨