ServiceGatewaysOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:service_gateways> attribute.

Constructor

ServiceGatewaysOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a service gateway.
begin_delete	Deletes the specified service gateway.
get	Gets the specified service gateway.
get_address_locations	Get address locations in service gateway.
get_services	Get Services in service gateway.
list	Gets all the service gateways in a resource group.
list_all	Gets all the service gateways in a subscription.
update_address_locations	Creates or updates address locations within the service gateway. The request supports both full and partial update modes at two levels: location and address. Full update replaces all existing data. Partial update modifies only the specified entries: For location-level partial updates, if no address is provided, the existing address will be deleted. For address-level partial updates, if no services are provided, the existing services will be considered for deletion.
update_services	Creates, updates, or deletes services within the service gateway. The request supports both full and partial update modes at the service level. Full update replaces all existing services with the new list provided in the request. Partial update modifies only the specified services.
update_tags	Updates a service gateway tags.

begin_create_or_update

Creates or updates a service gateway.

begin_create_or_update(resource_group_name: str, service_gateway_name: str, parameters: _models.ServiceGateway, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServiceGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
service_gateway_name Required	str The name of the service gateway. Required.
parameters Required	ServiceGateway or ServiceGateway or IO[bytes] Parameters supplied to the create or update service gateway operation. Is either a ServiceGateway type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[ServiceGateway]	An instance of LROPoller that returns ServiceGateway. The ServiceGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified service gateway.

begin_delete(resource_group_name: str, service_gateway_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
service_gateway_name Required	str The name of the service gateway. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

get

Gets the specified service gateway.

get(resource_group_name: str, service_gateway_name: str, **kwargs: Any) -> ServiceGateway

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
service_gateway_name Required	str The name of the service gateway. Required.

Returns

Type	Description
ServiceGateway	ServiceGateway. The ServiceGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_address_locations

Get address locations in service gateway.

get_address_locations(resource_group_name: str, service_gateway_name: str, **kwargs: Any) -> ItemPaged[ServiceGatewayAddressLocationResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
service_gateway_name Required	str The name of the service gateway. Required.

Returns

Type	Description
ItemPaged[ServiceGatewayAddressLocationResponse]	An iterator like instance of ServiceGatewayAddressLocationResponse

Exceptions

Type	Description
HttpResponseError

get_services

Get Services in service gateway.

get_services(resource_group_name: str, service_gateway_name: str, **kwargs: Any) -> ItemPaged[ServiceGatewayService]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
service_gateway_name Required	str The name of the service gateway. Required.

Returns

Type	Description
ItemPaged[ServiceGatewayService]	An iterator like instance of ServiceGatewayService

Exceptions

Type	Description
HttpResponseError

list

Gets all the service gateways in a resource group.

list(resource_group_name: str, **kwargs: Any) -> ItemPaged[ServiceGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[ServiceGateway]	An iterator like instance of ServiceGateway

Exceptions

Type	Description
HttpResponseError

list_all

Gets all the service gateways in a subscription.

list_all(**kwargs: Any) -> ItemPaged[ServiceGateway]

Returns

Type	Description
ItemPaged[ServiceGateway]	An iterator like instance of ServiceGateway

Exceptions

Type	Description
HttpResponseError

update_address_locations

Creates or updates address locations within the service gateway.

The request supports both full and partial update modes at two levels: location and address.

Full update replaces all existing data.

Partial update modifies only the specified entries:

For location-level partial updates, if no address is provided, the existing address will be deleted.

For address-level partial updates, if no services are provided, the existing services will be considered for deletion.

update_address_locations(resource_group_name: str, service_gateway_name: str, parameters: _models.ServiceGatewayUpdateAddressLocationsRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ServiceGatewayActionOkResponseBody

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
service_gateway_name Required	str The name of the service gateway. Required.
parameters Required	ServiceGatewayUpdateAddressLocationsRequest or ServiceGatewayUpdateAddressLocationsRequest or IO[bytes] Parameters supplied to create or update address locations in service gateway operation. Is either a ServiceGatewayUpdateAddressLocationsRequest type or a IO[bytes] type. Required.

Returns

Type	Description
ServiceGatewayActionOkResponseBody	ServiceGatewayActionOkResponseBody. The ServiceGatewayActionOkResponseBody is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

update_services

Creates, updates, or deletes services within the service gateway. The request supports both full and partial update modes at the service level.

Full update replaces all existing services with the new list provided in the request. Partial update modifies only the specified services.

update_services(resource_group_name: str, service_gateway_name: str, parameters: _models.ServiceGatewayUpdateServicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ServiceGatewayActionOkResponseBody

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
service_gateway_name Required	str The name of the service gateway. Required.
parameters Required	ServiceGatewayUpdateServicesRequest or ServiceGatewayUpdateServicesRequest or IO[bytes] Parameters supplied to create or update services in service gateway operation. Is either a ServiceGatewayUpdateServicesRequest type or a IO[bytes] type. Required.

Returns

Type	Description
ServiceGatewayActionOkResponseBody	ServiceGatewayActionOkResponseBody. The ServiceGatewayActionOkResponseBody is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

update_tags

Updates a service gateway tags.

update_tags(resource_group_name: str, service_gateway_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ServiceGateway

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
service_gateway_name Required	str The name of the service gateway. Required.
parameters Required	TagsObject or TagsObject or IO[bytes] Parameters supplied to update service gateway tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
ServiceGateway	ServiceGateway. The ServiceGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Commenti e suggerimenti

Questa pagina è stata utile?