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 Resource Manager 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 Resource Manager API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- gatewayName
-
string
Spring Cloud Gateway の名前。
- gatewayResource
- GatewayResource
作成または更新操作のゲートウェイ
オプション パラメーター。
戻り値
Promise<GatewayResource>
beginDelete(string, string, string, GatewaysDeleteOptionalParams)
既定の Spring Cloud ゲートウェイを無効にします。
function beginDelete(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- resourceGroupName
-
string
リソースを含むリソース グループの名前。 この値は、Azure Resource Manager 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 ゲートウェイを無効にします。
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソースを含むリソース グループの名前。 この値は、Azure Resource Manager 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 Resource Manager 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 Resource Manager 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 Resource Manager 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 Resource Manager 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 Resource Manager 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 Resource Manager 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 Resource Manager 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 Resource Manager API またはポータルから取得できます。
- serviceName
-
string
サービス リソースの名前。
- gatewayName
-
string
Spring Cloud Gateway の名前。
- validatePayload
- CustomDomainValidatePayload
検証するカスタム ドメイン ペイロード
オプション パラメーター。
戻り値
Promise<CustomDomainValidateResult>