ProductContract interface
製品の詳細。
- Extends
プロパティ
approval |
サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、サブスクライブ直後に開発者が製品の API を呼び出すことができます。 true の場合、管理者は、開発者が製品の API を使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。 |
description | 製品の説明。 HTML 書式設定タグを含めることができます。 |
display |
製品名。 |
state | 製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態は発行されません。 |
subscription |
この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "保護済み" と呼ばれ、製品に含まれる API への要求を成功させるために有効なサブスクリプション キーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプション キーなしで行うことができます。 新しい製品を作成するときに プロパティを省略した場合、値は true と見なされます。 |
subscriptions |
ユーザーがこの製品に対して同時に必要なサブスクリプションの数かどうか。 ユーザーサブスクリプションごとに無制限を許可するには、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
プロパティ値
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
name
リソース名注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
name?: string
プロパティ値
string
type
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
type?: string
プロパティ値
string