ServiceGatewaysOperations interface

Package:
@azure/arm-network

Interface representing a ServiceGateways operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdateAddressLocations
beginUpdateAddressLocationsAndWait
beginUpdateServices
beginUpdateServicesAndWait
createOrUpdate

Creates or updates a service gateway.
delete

Deletes the specified service gateway.
get

Gets the specified service gateway.
list

Gets all the service gateways in a resource group.
listAddressLocations

Get address locations in service gateway.
listAll

Gets all the service gateways in a subscription.
listServices

Get Services in service gateway.
updateAddressLocations

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

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

Updates a service gateway tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGateway, options?: ServiceGatewaysCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ServiceGateway>, ServiceGateway>>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGateway, options?: ServiceGatewaysCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ServiceGateway>, ServiceGateway>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGateway, options?: ServiceGatewaysCreateOrUpdateOptionalParams) => Promise<ServiceGateway>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGateway, options?: ServiceGatewaysCreateOrUpdateOptionalParams) => Promise<ServiceGateway>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysDeleteOptionalParams) => Promise<void>

beginUpdateAddressLocations

Warning

This API is now deprecated.

use updateAddressLocations instead

beginUpdateAddressLocations: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateAddressLocationsRequest, options?: ServiceGatewaysUpdateAddressLocationsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateAddressLocationsRequest, options?: ServiceGatewaysUpdateAddressLocationsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginUpdateAddressLocationsAndWait

Warning

This API is now deprecated.

use updateAddressLocations instead

beginUpdateAddressLocationsAndWait: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateAddressLocationsRequest, options?: ServiceGatewaysUpdateAddressLocationsOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateAddressLocationsRequest, options?: ServiceGatewaysUpdateAddressLocationsOptionalParams) => Promise<void>

beginUpdateServices

Warning

This API is now deprecated.

use updateServices instead

beginUpdateServices: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateServicesRequest, options?: ServiceGatewaysUpdateServicesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateServicesRequest, options?: ServiceGatewaysUpdateServicesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginUpdateServicesAndWait

Warning

This API is now deprecated.

use updateServices instead

beginUpdateServicesAndWait: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateServicesRequest, options?: ServiceGatewaysUpdateServicesOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateServicesRequest, options?: ServiceGatewaysUpdateServicesOptionalParams) => Promise<void>

createOrUpdate

Creates or updates a service gateway.

createOrUpdate: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGateway, options?: ServiceGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<ServiceGateway>, ServiceGateway>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGateway, options?: ServiceGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<ServiceGateway>, ServiceGateway>

delete

Deletes the specified service gateway.

delete: (resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the specified service gateway.

get: (resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysGetOptionalParams) => Promise<ServiceGateway>

Property Value

(resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysGetOptionalParams) => Promise<ServiceGateway>

list

Gets all the service gateways in a resource group.

list: (resourceGroupName: string, options?: ServiceGatewaysListOptionalParams) => PagedAsyncIterableIterator<ServiceGateway, ServiceGateway[], PageSettings>

Property Value

(resourceGroupName: string, options?: ServiceGatewaysListOptionalParams) => PagedAsyncIterableIterator<ServiceGateway, ServiceGateway[], PageSettings>

listAddressLocations

Get address locations in service gateway.

listAddressLocations: (resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysListAddressLocationsOptionalParams) => PagedAsyncIterableIterator<ServiceGatewayAddressLocationResponse, ServiceGatewayAddressLocationResponse[], PageSettings>

Property Value

(resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysListAddressLocationsOptionalParams) => PagedAsyncIterableIterator<ServiceGatewayAddressLocationResponse, ServiceGatewayAddressLocationResponse[], PageSettings>

listAll

Gets all the service gateways in a subscription.

listAll: (options?: ServiceGatewaysListAllOptionalParams) => PagedAsyncIterableIterator<ServiceGateway, ServiceGateway[], PageSettings>

Property Value

(options?: ServiceGatewaysListAllOptionalParams) => PagedAsyncIterableIterator<ServiceGateway, ServiceGateway[], PageSettings>

listServices

Get Services in service gateway.

listServices: (resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysListServicesOptionalParams) => PagedAsyncIterableIterator<ServiceGatewayService, ServiceGatewayService[], PageSettings>

Property Value

(resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysListServicesOptionalParams) => PagedAsyncIterableIterator<ServiceGatewayService, ServiceGatewayService[], PageSettings>

updateAddressLocations

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.

updateAddressLocations: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateAddressLocationsRequest, options?: ServiceGatewaysUpdateAddressLocationsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateAddressLocationsRequest, options?: ServiceGatewaysUpdateAddressLocationsOptionalParams) => PollerLike<OperationState<void>, void>

updateServices

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.

updateServices: (resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateServicesRequest, options?: ServiceGatewaysUpdateServicesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: ServiceGatewayUpdateServicesRequest, options?: ServiceGatewaysUpdateServicesOptionalParams) => PollerLike<OperationState<void>, void>

updateTags

Updates a service gateway tags.

updateTags: (resourceGroupName: string, serviceGatewayName: string, parameters: TagsObject, options?: ServiceGatewaysUpdateTagsOptionalParams) => Promise<ServiceGateway>

Property Value

(resourceGroupName: string, serviceGatewayName: string, parameters: TagsObject, options?: ServiceGatewaysUpdateTagsOptionalParams) => Promise<ServiceGateway>