SubscriptionCreateParameters interface

패키지:

@azure/arm-apimanagement

구독은 세부 정보를 만듭니다.

속성

allowTracing	추적을 사용할 수 있는지 여부를 결정합니다.
displayName	구독 이름입니다.
ownerId	/users/{userId} 형식으로 구독을 만드는 사용자(사용자 ID 경로)
primaryKey	기본 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다.
scope	/products/{productId} 또는 /api 또는 /apiId}와 같은 범위입니다.
secondaryKey	보조 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다.
state	초기 구독 상태입니다. 값을 지정하지 않으면 구독이 제출됨 상태로 만들어집니다. 가능한 상태는 * 활성 - 구독이 활성 상태이고, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청이 개발자에 의해 이루어졌지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 구독이 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 - 구독이 만료 날짜에 도달하여 비활성화되었습니다.

속성 세부 정보

allowTracing

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

allowTracing?: boolean

속성 값

boolean

displayName

구독 이름입니다.

displayName?: string

속성 값

string

ownerId

/users/{userId} 형식으로 구독을 만드는 사용자(사용자 ID 경로)

ownerId?: string

속성 값

string

primaryKey

기본 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다.

primaryKey?: string

속성 값

string

scope

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

scope?: string

속성 값

string

secondaryKey

보조 구독 키입니다. 요청 키 중에 지정하지 않으면 자동으로 생성됩니다.

secondaryKey?: string

속성 값

string

state

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

state?: SubscriptionState

속성 값

SubscriptionState