SubscriptionContract interface
サブスクリプションの詳細。
- Extends
プロパティ
allow |
トレースが有効になっているかどうかを判断します |
created |
サブスクリプションの作成日。 日付は、ISO 8601 標準で指定されている形式 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
display |
サブスクリプションの名前。サブスクリプションに名前がない場合は null。 |
end |
サブスクリプションが取り消されたか期限切れになった日付。 この設定は監査のみを目的としており、サブスクリプションは自動的に取り消されません。 サブスクリプションのライフサイクルは、 プロパティを使用 |
expiration |
サブスクリプションの有効期限。 この設定は監査のみを目的としており、サブスクリプションの有効期限は自動的には切れていません。 サブスクリプションのライフサイクルは、 プロパティを使用 |
notification |
今後のサブスクリプションの有効期限の通知日。 日付は、ISO 8601 標準で指定されている形式 |
owner |
サブスクリプション所有者のユーザー リソース識別子。 値は、/users/{userId} 形式の有効な相対 URL です。{userId} はユーザー識別子です。 |
primary |
サブスクリプションの主キー。 このプロパティは、'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 |
scope | /products/{productId} や /apis または /apis/{apiId} などのスコープ。 |
secondary |
サブスクリプションのセカンダリ キー。 このプロパティは、'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 |
start |
サブスクリプションのアクティブ化日。 この設定は監査のみを目的としており、サブスクリプションは自動的にアクティブ化されません。 サブスクリプションのライフサイクルは、 プロパティを使用 |
state | サブスクリプションの状態。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。 |
state |
状態が 'rejected' に変更されたときに管理者によって追加されるオプションのサブスクリプション コメント。 |
継承されたプロパティ
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} や /apis または /apis/{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
プロパティ値
stateComment
状態が 'rejected' に変更されたときに管理者によって追加されるオプションのサブスクリプション コメント。
stateComment?: 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