Gateways interface
表示网关的接口。
方法
方法详细信息
beginCreateOrUpdate(string, string, string, GatewayResource, GatewaysCreateOrUpdateOptionalParams)
创建默认的 Spring Cloud 网关或更新现有的 Spring Cloud 网关。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, gatewayName: string, gatewayResource: GatewayResource, options?: GatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GatewayResource>, GatewayResource>>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- gatewayResource
- GatewayResource
创建或更新作的网关
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayResource>, GatewayResource>>
beginCreateOrUpdateAndWait(string, string, string, GatewayResource, GatewaysCreateOrUpdateOptionalParams)
创建默认的 Spring Cloud 网关或更新现有的 Spring Cloud 网关。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, gatewayResource: GatewayResource, options?: GatewaysCreateOrUpdateOptionalParams): Promise<GatewayResource>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- gatewayResource
- GatewayResource
创建或更新作的网关
选项参数。
返回
Promise<GatewayResource>
beginDelete(string, string, string, GatewaysDeleteOptionalParams)
禁用默认 Spring Cloud Gateway。
function beginDelete(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- options
- GatewaysDeleteOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, GatewaysDeleteOptionalParams)
禁用默认 Spring Cloud Gateway。
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- options
- GatewaysDeleteOptionalParams
选项参数。
返回
Promise<void>
beginRestart(string, string, string, GatewaysRestartOptionalParams)
重启 Spring Cloud 网关。
function beginRestart(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- options
- GatewaysRestartOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRestartAndWait(string, string, string, GatewaysRestartOptionalParams)
重启 Spring Cloud 网关。
function beginRestartAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysRestartOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- options
- GatewaysRestartOptionalParams
选项参数。
返回
Promise<void>
beginUpdateCapacity(string, string, string, SkuObject, GatewaysUpdateCapacityOptionalParams)
更新现有 Spring Cloud Gateway 容量的作。
function beginUpdateCapacity(resourceGroupName: string, serviceName: string, gatewayName: string, gatewayCapacityResource: SkuObject, options?: GatewaysUpdateCapacityOptionalParams): Promise<SimplePollerLike<OperationState<GatewayResource>, GatewayResource>>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- gatewayCapacityResource
- SkuObject
更新作的网关容量
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayResource>, GatewayResource>>
beginUpdateCapacityAndWait(string, string, string, SkuObject, GatewaysUpdateCapacityOptionalParams)
更新现有 Spring Cloud Gateway 容量的作。
function beginUpdateCapacityAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, gatewayCapacityResource: SkuObject, options?: GatewaysUpdateCapacityOptionalParams): Promise<GatewayResource>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- gatewayCapacityResource
- SkuObject
更新作的网关容量
选项参数。
返回
Promise<GatewayResource>
get(string, string, string, GatewaysGetOptionalParams)
获取 Spring Cloud Gateway 及其属性。
function get(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysGetOptionalParams): Promise<GatewayResource>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- options
- GatewaysGetOptionalParams
选项参数。
返回
Promise<GatewayResource>
list(string, string, GatewaysListOptionalParams)
处理请求以列出服务中的所有资源。
function list(resourceGroupName: string, serviceName: string, options?: GatewaysListOptionalParams): PagedAsyncIterableIterator<GatewayResource, GatewayResource[], PageSettings>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- options
- GatewaysListOptionalParams
选项参数。
返回
listEnvSecrets(string, string, string, GatewaysListEnvSecretsOptionalParams)
列出 Spring Cloud Gateway 的敏感环境变量。
function listEnvSecrets(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysListEnvSecretsOptionalParams): Promise<GatewaysListEnvSecretsResponse>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
选项参数。
返回
Promise<GatewaysListEnvSecretsResponse>
validateDomain(string, string, string, CustomDomainValidatePayload, GatewaysValidateDomainOptionalParams)
检查域是否有效且未使用。
function validateDomain(resourceGroupName: string, serviceName: string, gatewayName: string, validatePayload: CustomDomainValidatePayload, options?: GatewaysValidateDomainOptionalParams): Promise<CustomDomainValidateResult>
参数
- resourceGroupName
-
string
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
- serviceName
-
string
服务资源的名称。
- gatewayName
-
string
Spring Cloud Gateway 的名称。
- validatePayload
- CustomDomainValidatePayload
要验证的自定义域有效负载
选项参数。
返回
Promise<CustomDomainValidateResult>