你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Gateway interface
表示网关的接口。
方法
方法详细信息
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
创建或更新要用于 Api 管理实例的网关。
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- parameters
- GatewayContract
网关详细信息。
选项参数。
返回
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
删除特定的网关。
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
- options
- GatewayDeleteOptionalParams
选项参数。
返回
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
获取网关的共享访问授权令牌。
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- parameters
- GatewayTokenRequestContract
网关令牌请求协定属性。
选项参数。
返回
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
获取由其标识符指定的网关的详细信息。
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- options
- GatewayGetOptionalParams
选项参数。
返回
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
获取实体状态 (Etag) 由其标识符指定的网关版本。
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
选项参数。
返回
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
列出已注册到服务实例的网关集合。
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
listKeys(string, string, string, GatewayListKeysOptionalParams)
检索网关密钥。
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- options
- GatewayListKeysOptionalParams
选项参数。
返回
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
重新生成指定的网关密钥，使使用它创建的任何令牌失效。
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- parameters
- GatewayKeyRegenerationRequestContract
网关密钥重新生成请求协定属性。
选项参数。
返回
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
汇报标识符指定的网关的详细信息。
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
- parameters
- GatewayContract
网关详细信息。
- options
- GatewayUpdateOptionalParams
选项参数。
返回
Promise<GatewayUpdateResponse>