Policy interface
ポリシーを表すインターフェイス。
メソッド
| create |
API Management サービスのグローバル ポリシー構成を作成または更新します。 |
| delete(string, string, string, string, Policy |
API Management サービスのグローバル ポリシー構成を削除します。 |
| get(string, string, string, Policy |
API Management サービスのグローバル ポリシー定義を取得します。 |
| get |
Api Management サービスのグローバル ポリシー定義のエンティティ状態 (Etag) バージョンを取得します。 |
| list |
API Management サービスのすべてのグローバル ポリシー定義を一覧表示します。 |
メソッドの詳細
createOrUpdate(string, string, string, PolicyContract, PolicyCreateOrUpdateOptionalParams)
API Management サービスのグローバル ポリシー構成を作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, policyId: string, parameters: PolicyContract, options?: PolicyCreateOrUpdateOptionalParams): Promise<PolicyCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- policyId
-
string
ポリシーの識別子。
- parameters
- PolicyContract
適用するポリシーの内容。
options パラメーター。
戻り値
Promise<PolicyCreateOrUpdateResponse>
delete(string, string, string, string, PolicyDeleteOptionalParams)
API Management サービスのグローバル ポリシー構成を削除します。
function delete(resourceGroupName: string, serviceName: string, policyId: string, ifMatch: string, options?: PolicyDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- policyId
-
string
ポリシーの識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- PolicyDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, PolicyGetOptionalParams)
API Management サービスのグローバル ポリシー定義を取得します。
function get(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetOptionalParams): Promise<PolicyGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- policyId
-
string
ポリシーの識別子。
- options
- PolicyGetOptionalParams
options パラメーター。
戻り値
Promise<PolicyGetResponse>
getEntityTag(string, string, string, PolicyGetEntityTagOptionalParams)
Api Management サービスのグローバル ポリシー定義のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetEntityTagOptionalParams): Promise<PolicyGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- policyId
-
string
ポリシーの識別子。
- options
- PolicyGetEntityTagOptionalParams
options パラメーター。
戻り値
Promise<PolicyGetEntityTagHeaders>
listByService(string, string, PolicyListByServiceOptionalParams)
API Management サービスのすべてのグローバル ポリシー定義を一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: PolicyListByServiceOptionalParams): Promise<PolicyCollection>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<PolicyCollection>