Package version:

Interface Gateways

Interface representing a Gateways.

Hierarchy

Gateways

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get list validateDomain

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, gatewayName: string, gatewayResource: GatewayResource, options?: GatewaysCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<GatewayResource>, GatewayResource>>
Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.
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
- Optional options: GatewaysCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GatewayResource>, GatewayResource>>
- Defined in operationsInterfaces/gateways.ts:62

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, gatewayResource: GatewayResource, options?: GatewaysCreateOrUpdateOptionalParams): Promise<GatewayResource>
Create the default Spring Cloud Gateway or update the existing Spring Cloud Gateway.
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
- Optional options: GatewaysCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<GatewayResource>
- Defined in operationsInterfaces/gateways.ts:83

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Disable the default Spring Cloud Gateway.
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.
- Optional options: GatewaysDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/gateways.ts:98

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<void>
Disable the default Spring Cloud Gateway.
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.
- Optional options: GatewaysDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/gateways.ts:112

get

get(resourceGroupName: string, serviceName: string, gatewayName: string, options?: GatewaysGetOptionalParams): Promise<GatewayResource>
Get the Spring Cloud Gateway and its properties.
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.
- Optional options: GatewaysGetOptionalParams
  
  The options parameters.
Returns Promise<GatewayResource>
- Defined in operationsInterfaces/gateways.ts:47

list

list(resourceGroupName: string, serviceName: string, options?: GatewaysListOptionalParams): PagedAsyncIterableIterator<GatewayResource>
Handles requests to list all resources in a Service.
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.
- Optional options: GatewaysListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GatewayResource>
- Defined in operationsInterfaces/gateways.ts:34

validateDomain

validateDomain(resourceGroupName: string, serviceName: string, gatewayName: string, validatePayload: CustomDomainValidatePayload, options?: GatewaysValidateDomainOptionalParams): Promise<CustomDomainValidateResult>
Check the domains are valid as well as not in use.
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
- Optional options: GatewaysValidateDomainOptionalParams
  
  The options parameters.
Returns Promise<CustomDomainValidateResult>
- Defined in operationsInterfaces/gateways.ts:127

Interface Gateways

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

gatewayName: string

gatewayResource: GatewayResource

Optional options: GatewaysCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<GatewayResource>, GatewayResource>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

gatewayName: string

gatewayResource: GatewayResource

Optional options: GatewaysCreateOrUpdateOptionalParams

Returns Promise<GatewayResource>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

gatewayName: string

Optional options: GatewaysDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

gatewayName: string

Optional options: GatewaysDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

gatewayName: string

Optional options: GatewaysGetOptionalParams

Returns Promise<GatewayResource>

list

Parameters

resourceGroupName: string

serviceName: string

Optional options: GatewaysListOptionalParams

Returns PagedAsyncIterableIterator<GatewayResource>

validateDomain

Parameters

resourceGroupName: string

serviceName: string

gatewayName: string

validatePayload: CustomDomainValidatePayload

Optional options: GatewaysValidateDomainOptionalParams

Returns Promise<CustomDomainValidateResult>

Settings

Member Visibility

Theme

`Optional` options: GatewaysCreateOrUpdateOptionalParams

`Optional` options: GatewaysCreateOrUpdateOptionalParams

`Optional` options: GatewaysDeleteOptionalParams

`Optional` options: GatewaysDeleteOptionalParams

`Optional` options: GatewaysGetOptionalParams

`Optional` options: GatewaysListOptionalParams

`Optional` options: GatewaysValidateDomainOptionalParams