Share via

ServiceGatewaysOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<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.
begin_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.
begin_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.
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_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 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 either ServiceGateway or the result of cls(response)

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 either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_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.

begin_update_address_locations(resource_group_name: str, service_gateway_name: str, parameters: _models.ServiceGatewayUpdateAddressLocationsRequest, *, content_type: str = 'application/json', **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.
parameters
Required
ServiceGatewayUpdateAddressLocationsRequest or IO[bytes]

Parameters supplied to the create or updates address locations in service gateway operation. Is either a ServiceGatewayUpdateAddressLocationsRequest type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_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.

begin_update_services(resource_group_name: str, service_gateway_name: str, parameters: _models.ServiceGatewayUpdateServicesRequest, *, content_type: str = 'application/json', **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.
parameters
Required
ServiceGatewayUpdateServicesRequest or IO[bytes]

Parameters supplied to the create or updates services in service gateway operation. Is either a ServiceGatewayUpdateServicesRequest type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[None]

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

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 or the result of cls(response)

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 either ServiceGatewayAddressLocationResponse or the result of cls(response)

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 either ServiceGatewayService or the result of cls(response)

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 either ServiceGateway or the result of cls(response)

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 either ServiceGateway or the result of cls(response)

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 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 or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.network.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv179\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>