ProductContract interface

パッケージ:

@azure/arm-apimanagement

製品の詳細。

Extends

ProxyResource

プロパティ

approvalRequired	サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、サブスクライブした直後に開発者が製品の API を呼び出すようになります。 true の場合、管理者は、開発者が製品の API を使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
description	製品説明。 HTML 書式設定タグを含めることができます。
displayName	製品名。
state	製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態は発行されません。
subscriptionRequired	この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "保護済み" と呼ばれ、製品に含まれる API への要求が成功するためには有効なサブスクリプション キーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプション キーなしで行うことができます。 新しい製品を作成するときにプロパティを省略すると、値は true と見なされます。
subscriptionsLimit	ユーザーがこの製品に対して同時に必要なサブスクリプションの数かどうか。 ユーザー サブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
terms	製品使用条件。 製品をサブスクライブしようとしている開発者は、サブスクリプション プロセスを完了する前に、これらの条件に同意する必要があります。

継承されたプロパティ

id	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name	リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
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

製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態は発行されません。

state?: ProductState

プロパティ値

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

リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

継承元ProxyResource.name

type

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

継承元ProxyResource.type