Policy interface
表示策略的接口。
方法
| create |
创建或更新 Api 管理服务的全局策略配置。 |
| delete(string, string, string, string, Policy |
删除 Api 管理服务的全局策略配置。 |
| get(string, string, string, Policy |
获取 Api 管理服务的全局策略定义。 |
| get |
获取 Api 管理服务中全局策略定义的实体状态 （Etag） 版本。 |
| list |
列出 Api 管理服务的所有全局策略定义。 |
方法详细信息
createOrUpdate(string, string, string, PolicyContract, PolicyCreateOrUpdateOptionalParams)
创建或更新 Api 管理服务的全局策略配置。
function createOrUpdate(resourceGroupName: string, serviceName: string, policyId: string, parameters: PolicyContract, options?: PolicyCreateOrUpdateOptionalParams): Promise<PolicyCreateOrUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- policyId
-
string
策略的标识符。
- parameters
- PolicyContract
要应用的策略内容。
选项参数。
返回
Promise<PolicyCreateOrUpdateResponse>
delete(string, string, string, string, PolicyDeleteOptionalParams)
删除 Api 管理服务的全局策略配置。
function delete(resourceGroupName: string, serviceName: string, policyId: string, ifMatch: string, options?: PolicyDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- policyId
-
string
策略的标识符。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。
- options
- PolicyDeleteOptionalParams
选项参数。
返回
Promise<void>
get(string, string, string, PolicyGetOptionalParams)
获取 Api 管理服务的全局策略定义。
function get(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetOptionalParams): Promise<PolicyGetResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- policyId
-
string
策略的标识符。
- options
- PolicyGetOptionalParams
选项参数。
返回
Promise<PolicyGetResponse>
getEntityTag(string, string, string, PolicyGetEntityTagOptionalParams)
获取 Api 管理服务中全局策略定义的实体状态 （Etag） 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetEntityTagOptionalParams): Promise<PolicyGetEntityTagHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- policyId
-
string
策略的标识符。
- options
- PolicyGetEntityTagOptionalParams
选项参数。
返回
Promise<PolicyGetEntityTagHeaders>
listByService(string, string, PolicyListByServiceOptionalParams)
列出 Api 管理服务的所有全局策略定义。
function listByService(resourceGroupName: string, serviceName: string, options?: PolicyListByServiceOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。