ServiceGateways interface

Package:

@azure/arm-network

Interface representing a ServiceGateways.

Methods

beginCreateOrUpdate(string, string, ServiceGateway, ServiceGatewaysCreateOrUpdateOptionalParams)	Creates or updates a service gateway.
beginCreateOrUpdateAndWait(string, string, ServiceGateway, ServiceGatewaysCreateOrUpdateOptionalParams)	Creates or updates a service gateway.
beginDelete(string, string, ServiceGatewaysDeleteOptionalParams)	Deletes the specified service gateway.
beginDeleteAndWait(string, string, ServiceGatewaysDeleteOptionalParams)	Deletes the specified service gateway.
beginUpdateAddressLocations(string, string, ServiceGatewayUpdateAddressLocationsRequest, ServiceGatewaysUpdateAddressLocationsOptionalParams)	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.
beginUpdateAddressLocationsAndWait(string, string, ServiceGatewayUpdateAddressLocationsRequest, ServiceGatewaysUpdateAddressLocationsOptionalParams)	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.
beginUpdateServices(string, string, ServiceGatewayUpdateServicesRequest, ServiceGatewaysUpdateServicesOptionalParams)	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.
beginUpdateServicesAndWait(string, string, ServiceGatewayUpdateServicesRequest, ServiceGatewaysUpdateServicesOptionalParams)	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(string, string, ServiceGatewaysGetOptionalParams)	Gets the specified service gateway.
list(string, ServiceGatewaysListOptionalParams)	Gets all the service gateways in a resource group.
listAddressLocations(string, string, ServiceGatewaysGetAddressLocationsOptionalParams)	Get address locations in service gateway.
listAll(ServiceGatewaysListAllOptionalParams)	Gets all the service gateways in a subscription.
listServices(string, string, ServiceGatewaysGetServicesOptionalParams)	Get Services in service gateway.
updateTags(string, string, TagsObject, ServiceGatewaysUpdateTagsOptionalParams)	Updates a service gateway tags.

Method Details

beginCreateOrUpdate(string, string, ServiceGateway, ServiceGatewaysCreateOrUpdateOptionalParams)

Creates or updates a service gateway.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

parameters

ServiceGateway

Parameters supplied to the create or update service gateway operation.

options

ServiceGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServiceGateway>, ServiceGateway>>

beginCreateOrUpdateAndWait(string, string, ServiceGateway, ServiceGatewaysCreateOrUpdateOptionalParams)

Creates or updates a service gateway.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

parameters

ServiceGateway

Parameters supplied to the create or update service gateway operation.

options

ServiceGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ServiceGateway>

beginDelete(string, string, ServiceGatewaysDeleteOptionalParams)

Deletes the specified service gateway.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

options

ServiceGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServiceGatewaysDeleteHeaders>, ServiceGatewaysDeleteHeaders>>

beginDeleteAndWait(string, string, ServiceGatewaysDeleteOptionalParams)

Deletes the specified service gateway.

function beginDeleteAndWait(resourceGroupName: string, serviceGatewayName: string, options?: ServiceGatewaysDeleteOptionalParams): Promise<ServiceGatewaysDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

options

ServiceGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<ServiceGatewaysDeleteHeaders>

beginUpdateAddressLocations(string, string, ServiceGatewayUpdateAddressLocationsRequest, ServiceGatewaysUpdateAddressLocationsOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

parameters

ServiceGatewayUpdateAddressLocationsRequest

Parameters supplied to the create or updates address locations in service gateway operation.

options

ServiceGatewaysUpdateAddressLocationsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServiceGatewaysUpdateAddressLocationsHeaders>, ServiceGatewaysUpdateAddressLocationsHeaders>>

beginUpdateAddressLocationsAndWait(string, string, ServiceGatewayUpdateAddressLocationsRequest, ServiceGatewaysUpdateAddressLocationsOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

parameters

ServiceGatewayUpdateAddressLocationsRequest

Parameters supplied to the create or updates address locations in service gateway operation.

options

ServiceGatewaysUpdateAddressLocationsOptionalParams

The options parameters.

Returns

Promise<ServiceGatewaysUpdateAddressLocationsHeaders>

beginUpdateServices(string, string, ServiceGatewayUpdateServicesRequest, ServiceGatewaysUpdateServicesOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

parameters

ServiceGatewayUpdateServicesRequest

Parameters supplied to the create or updates services in service gateway operation.

options

ServiceGatewaysUpdateServicesOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServiceGatewaysUpdateServicesHeaders>, ServiceGatewaysUpdateServicesHeaders>>

beginUpdateServicesAndWait(string, string, ServiceGatewayUpdateServicesRequest, ServiceGatewaysUpdateServicesOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

parameters

ServiceGatewayUpdateServicesRequest

Parameters supplied to the create or updates services in service gateway operation.

options

ServiceGatewaysUpdateServicesOptionalParams

The options parameters.

Returns

Promise<ServiceGatewaysUpdateServicesHeaders>

get(string, string, ServiceGatewaysGetOptionalParams)

Gets the specified service gateway.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

options

ServiceGatewaysGetOptionalParams

The options parameters.

Returns

Promise<ServiceGateway>

list(string, ServiceGatewaysListOptionalParams)

Gets all the service gateways in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

ServiceGatewaysListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServiceGateway, ServiceGateway[], PageSettings>

listAddressLocations(string, string, ServiceGatewaysGetAddressLocationsOptionalParams)

Get address locations in service gateway.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

options

ServiceGatewaysGetAddressLocationsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServiceGatewayAddressLocationResponse, ServiceGatewayAddressLocationResponse[], PageSettings>

listAll(ServiceGatewaysListAllOptionalParams)

Gets all the service gateways in a subscription.

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

Parameters

options

ServiceGatewaysListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServiceGateway, ServiceGateway[], PageSettings>

listServices(string, string, ServiceGatewaysGetServicesOptionalParams)

Get Services in service gateway.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

options

ServiceGatewaysGetServicesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServiceGatewayService, ServiceGatewayService[], PageSettings>

updateTags(string, string, TagsObject, ServiceGatewaysUpdateTagsOptionalParams)

Updates a service gateway tags.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceGatewayName

string

The name of the service gateway.

parameters

TagsObject

Parameters supplied to update service gateway tags.

options

ServiceGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

Promise<ServiceGateway>