Gateways interface

Package:

@azure/arm-appplatform

Interface representing a Gateways.

Methods

beginCreateOrUpdate(string, string, string, GatewayResource, GatewaysCreateOrUpdateOptionalParams)	Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.
beginCreateOrUpdateAndWait(string, string, string, GatewayResource, GatewaysCreateOrUpdateOptionalParams)	Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.
beginDelete(string, string, string, GatewaysDeleteOptionalParams)	Disable the default Spring Cloud Gateway.
beginDeleteAndWait(string, string, string, GatewaysDeleteOptionalParams)	Disable the default Spring Cloud Gateway.
beginRestart(string, string, string, GatewaysRestartOptionalParams)	Restart the Spring Cloud Gateway.
beginRestartAndWait(string, string, string, GatewaysRestartOptionalParams)	Restart the Spring Cloud Gateway.
get(string, string, string, GatewaysGetOptionalParams)	Get the Spring Cloud Gateway and its properties.
list(string, string, GatewaysListOptionalParams)	Handles requests to list all resources in a Service.
listEnvSecrets(string, string, string, GatewaysListEnvSecretsOptionalParams)	List sensitive environment variables of Spring Cloud Gateway.
validateDomain(string, string, string, CustomDomainValidatePayload, GatewaysValidateDomainOptionalParams)	Check the domains are valid as well as not in use.

Method Details

beginCreateOrUpdate(string, string, string, GatewayResource, GatewaysCreateOrUpdateOptionalParams)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, gatewayName: string, gatewayResource: GatewayResource, options?: GatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GatewayResource>, GatewayResource>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

gatewayResource

GatewayResource

The gateway for the create or update operation

options

GatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayResource>, GatewayResource>>

beginCreateOrUpdateAndWait(string, string, string, GatewayResource, GatewaysCreateOrUpdateOptionalParams)

Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, gatewayResource: GatewayResource, options?: GatewaysCreateOrUpdateOptionalParams): Promise<GatewayResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

gatewayResource

GatewayResource

The gateway for the create or update operation

options

GatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<GatewayResource>

beginDelete(string, string, string, GatewaysDeleteOptionalParams)

Disable the default Spring Cloud Gateway.

function beginDelete(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

options

GatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, GatewaysDeleteOptionalParams)

Disable the default Spring Cloud Gateway.

function beginDeleteAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

options

GatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRestart(string, string, string, GatewaysRestartOptionalParams)

Restart the Spring Cloud Gateway.

function beginRestart(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

options

GatewaysRestartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, string, GatewaysRestartOptionalParams)

Restart the Spring Cloud Gateway.

function beginRestartAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysRestartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

options

GatewaysRestartOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, GatewaysGetOptionalParams)

Get the Spring Cloud Gateway and its properties.

function get(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysGetOptionalParams): Promise<GatewayResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

options

GatewaysGetOptionalParams

The options parameters.

Returns

Promise<GatewayResource>

list(string, string, GatewaysListOptionalParams)

Handles requests to list all resources in a Service.

function list(resourceGroupName: string, serviceName: string, options?: GatewaysListOptionalParams): PagedAsyncIterableIterator<GatewayResource, GatewayResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

options

GatewaysListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GatewayResource, GatewayResource[], PageSettings>

listEnvSecrets(string, string, string, GatewaysListEnvSecretsOptionalParams)

List sensitive environment variables of Spring Cloud Gateway.

function listEnvSecrets(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysListEnvSecretsOptionalParams): Promise<GatewaysListEnvSecretsResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

options

GatewaysListEnvSecretsOptionalParams

The options parameters.

Returns

Promise<GatewaysListEnvSecretsResponse>

validateDomain(string, string, string, CustomDomainValidatePayload, GatewaysValidateDomainOptionalParams)

Check the domains are valid as well as not in use.

function validateDomain(resourceGroupName: string, serviceName: string, gatewayName: string, validatePayload: CustomDomainValidatePayload, options?: GatewaysValidateDomainOptionalParams): Promise<CustomDomainValidateResult>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

gatewayName

string

The name of Spring Cloud Gateway.

validatePayload

CustomDomainValidatePayload

Custom domain payload to be validated

options

GatewaysValidateDomainOptionalParams

The options parameters.

Returns

Promise<CustomDomainValidateResult>