ProductContract interface

제품 세부 정보.

Extends

속성

approvalRequired

구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.

description

제품 설명. HTML 서식 지정 태그를 포함할 수 있습니다.

displayName

제품 이름입니다.

state

제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 게시되지 않습니다.

subscriptionRequired

이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다. true이면 제품을 "보호됨"이라고 하며 제품에 포함된 API에 대한 요청이 성공하려면 유효한 구독 키가 필요합니다. false이면 제품을 "열기"라고 하며 제품에 포함된 API에 대한 요청은 구독 키 없이 수행할 수 있습니다. 새 제품을 만들 때 속성을 생략하면 값이 true로 간주됩니다.

subscriptionsLimit

사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.

terms

제품 사용 약관입니다. 제품을 구독하려는 개발자에게 표시되며 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다.

상속된 속성

id

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

name

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

type

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

속성 세부 정보

approvalRequired

구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.

approvalRequired?: boolean

속성 값

boolean

description

제품 설명. HTML 서식 지정 태그를 포함할 수 있습니다.

description?: string

속성 값

string

displayName

제품 이름입니다.

displayName?: string

속성 값

string

state

제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 게시되지 않습니다.

state?: ProductState

속성 값

subscriptionRequired

이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다. true이면 제품을 "보호됨"이라고 하며 제품에 포함된 API에 대한 요청이 성공하려면 유효한 구독 키가 필요합니다. false이면 제품을 "열기"라고 하며 제품에 포함된 API에 대한 요청은 구독 키 없이 수행할 수 있습니다. 새 제품을 만들 때 속성을 생략하면 값이 true로 간주됩니다.

subscriptionRequired?: boolean

속성 값

boolean

subscriptionsLimit

사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.

subscriptionsLimit?: number

속성 값

number

terms

제품 사용 약관입니다. 제품을 구독하려는 개발자에게 표시되며 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다.

terms?: string

속성 값

string

상속된 속성 세부 정보

id

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

id?: string

속성 값

string

상속된ProxyResource.id

name

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

name?: string

속성 값

string

상속된ProxyResource.name

type

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

type?: string

속성 값

string

ProxyResource.type에서 상속됨