GatewayCustomDomainsOperations Class

GatewayCustomDomainsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

GatewayCustomDomainsOperations

Constructor

GatewayCustomDomainsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update	Create or update the Spring Cloud Gateway custom domain.
begin_delete	Delete the Spring Cloud Gateway custom domain.
get	Get the Spring Cloud Gateway custom domain.
list	Handle requests to list all Spring Cloud Gateway custom domains.

begin_create_or_update

Create or update the Spring Cloud Gateway custom domain.

async begin_create_or_update(resource_group_name: str, service_name: str, gateway_name: str, domain_name: str, gateway_custom_domain_resource: azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.GatewayCustomDomainResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.GatewayCustomDomainResource]

Parameters

resource_group_name

str

Required

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

service_name

str

Required

The name of the Service resource.

gateway_name

str

Required

The name of Spring Cloud Gateway.

domain_name

str

Required

The name of the Spring Cloud Gateway custom domain.

gateway_custom_domain_resource

GatewayCustomDomainResource

Required

The gateway custom domain resource for the create or update operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either GatewayCustomDomainResource or the result of cls(response)

Return type

AsyncLROPoller[GatewayCustomDomainResource]

Exceptions

HttpResponseError

begin_delete

Delete the Spring Cloud Gateway custom domain.

async begin_delete(resource_group_name: str, service_name: str, gateway_name: str, domain_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

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

service_name

str

Required

The name of the Service resource.

gateway_name

str

Required

The name of Spring Cloud Gateway.

domain_name

str

Required

The name of the Spring Cloud Gateway custom domain.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Get the Spring Cloud Gateway custom domain.

async get(resource_group_name: str, service_name: str, gateway_name: str, domain_name: str, **kwargs: Any) -> azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.GatewayCustomDomainResource

Parameters

resource_group_name

str

Required

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

service_name

str

Required

The name of the Service resource.

gateway_name

str

Required

The name of Spring Cloud Gateway.

domain_name

str

Required

The name of the Spring Cloud Gateway custom domain.

cls

callable

A custom type or function that will be passed the direct response

Returns

GatewayCustomDomainResource, or the result of cls(response)

Return type

GatewayCustomDomainResource

Exceptions

HttpResponseError

list

Handle requests to list all Spring Cloud Gateway custom domains.

list(resource_group_name: str, service_name: str, gateway_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.appplatform.v2022_01_01_preview.models._models_py3.GatewayCustomDomainResourceCollection]

Parameters

resource_group_name

str

Required

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

service_name

str

Required

The name of the Service resource.

gateway_name

str

Required

The name of Spring Cloud Gateway.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GatewayCustomDomainResourceCollection or the result of cls(response)

Return type

AsyncItemPaged[GatewayCustomDomainResourceCollection]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.appplatform.v2022_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\appplatform\\v2022_01_01_preview\\models\\__init__.py'>