ProductPolicy interface
ProductPolicy を表すインターフェイス。
メソッド
| create |
製品のポリシー構成を作成または更新します。 |
| delete(string, string, string, string, string, Product |
製品のポリシー構成を削除します。 |
| get(string, string, string, string, Product |
製品レベルでポリシー構成を取得します。 |
| get |
製品レベルでポリシー構成の ETag を取得します。 |
| list |
製品レベルでポリシー構成を取得します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, PolicyContract, ProductPolicyCreateOrUpdateOptionalParams)
製品のポリシー構成を作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, policyId: string, parameters: PolicyContract, options?: ProductPolicyCreateOrUpdateOptionalParams): Promise<ProductPolicyCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- policyId
-
string
ポリシーの識別子。
- parameters
- PolicyContract
適用するポリシーの内容。
options パラメーター。
戻り値
Promise<ProductPolicyCreateOrUpdateResponse>
delete(string, string, string, string, string, ProductPolicyDeleteOptionalParams)
製品のポリシー構成を削除します。
function delete(resourceGroupName: string, serviceName: string, productId: string, policyId: string, ifMatch: string, options?: ProductPolicyDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- policyId
-
string
ポリシーの識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, ProductPolicyGetOptionalParams)
製品レベルでポリシー構成を取得します。
function get(resourceGroupName: string, serviceName: string, productId: string, policyId: string, options?: ProductPolicyGetOptionalParams): Promise<ProductPolicyGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- policyId
-
string
ポリシーの識別子。
- options
- ProductPolicyGetOptionalParams
options パラメーター。
戻り値
Promise<ProductPolicyGetResponse>
getEntityTag(string, string, string, string, ProductPolicyGetEntityTagOptionalParams)
製品レベルでポリシー構成の ETag を取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, policyId: string, options?: ProductPolicyGetEntityTagOptionalParams): Promise<ProductPolicyGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- policyId
-
string
ポリシーの識別子。
options パラメーター。
戻り値
Promise<ProductPolicyGetEntityTagHeaders>
listByProduct(string, string, string, ProductPolicyListByProductOptionalParams)
製品レベルでポリシー構成を取得します。
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductPolicyListByProductOptionalParams): Promise<PolicyCollection>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<PolicyCollection>