Gateways interface

Package:

@azure/arm-hybridcompute

Interface representing a Gateways.

Methods

beginCreateOrUpdate(string, string, Gateway, GatewaysCreateOrUpdateOptionalParams)	The operation to create or update a gateway.
beginCreateOrUpdateAndWait(string, string, Gateway, GatewaysCreateOrUpdateOptionalParams)	The operation to create or update a gateway.
beginDelete(string, string, GatewaysDeleteOptionalParams)	The operation to delete a gateway.
beginDeleteAndWait(string, string, GatewaysDeleteOptionalParams)	The operation to delete a gateway.
get(string, string, GatewaysGetOptionalParams)	Retrieves information about the view of a gateway.
listByResourceGroup(string, GatewaysListByResourceGroupOptionalParams)	The operation to get all gateways of a non-Azure machine
listBySubscription(GatewaysListBySubscriptionOptionalParams)	The operation to get all gateways of a non-Azure machine
update(string, string, GatewayUpdate, GatewaysUpdateOptionalParams)	The operation to update a gateway.

Method Details

beginCreateOrUpdate(string, string, Gateway, GatewaysCreateOrUpdateOptionalParams)

The operation to create or update a gateway.

function beginCreateOrUpdate(resourceGroupName: string, gatewayName: string, parameters: Gateway, options?: GatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Gateway>, Gateway>>

Parameters

resourceGroupName

string

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

gatewayName

string

The name of the Gateway.

parameters

Gateway

Parameters supplied to the Create gateway operation.

options

GatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, Gateway, GatewaysCreateOrUpdateOptionalParams)

The operation to create or update a gateway.

function beginCreateOrUpdateAndWait(resourceGroupName: string, gatewayName: string, parameters: Gateway, options?: GatewaysCreateOrUpdateOptionalParams): Promise<Gateway>

Parameters

resourceGroupName

string

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

gatewayName

string

The name of the Gateway.

parameters

Gateway

Parameters supplied to the Create gateway operation.

options

GatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Gateway>

beginDelete(string, string, GatewaysDeleteOptionalParams)

The operation to delete a gateway.

function beginDelete(resourceGroupName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<GatewaysDeleteHeaders>, GatewaysDeleteHeaders>>

Parameters

resourceGroupName

string

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

gatewayName

string

The name of the Gateway.

options

GatewaysDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, GatewaysDeleteOptionalParams)

The operation to delete a gateway.

function beginDeleteAndWait(resourceGroupName: string, gatewayName: string, options?: GatewaysDeleteOptionalParams): Promise<GatewaysDeleteHeaders>

Parameters

resourceGroupName

string

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

gatewayName

string

The name of the Gateway.

options

GatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<GatewaysDeleteHeaders>

get(string, string, GatewaysGetOptionalParams)

Retrieves information about the view of a gateway.

function get(resourceGroupName: string, gatewayName: string, options?: GatewaysGetOptionalParams): Promise<Gateway>

Parameters

resourceGroupName

string

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

gatewayName

string

The name of the Gateway.

options

GatewaysGetOptionalParams

The options parameters.

Returns

Promise<Gateway>

listByResourceGroup(string, GatewaysListByResourceGroupOptionalParams)

The operation to get all gateways of a non-Azure machine

function listByResourceGroup(resourceGroupName: string, options?: GatewaysListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Gateway, Gateway[], PageSettings>

Parameters

resourceGroupName

string

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

options

GatewaysListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Gateway, Gateway[], PageSettings>

listBySubscription(GatewaysListBySubscriptionOptionalParams)

The operation to get all gateways of a non-Azure machine

function listBySubscription(options?: GatewaysListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Gateway, Gateway[], PageSettings>

Parameters

options

GatewaysListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Gateway, Gateway[], PageSettings>

update(string, string, GatewayUpdate, GatewaysUpdateOptionalParams)

The operation to update a gateway.

function update(resourceGroupName: string, gatewayName: string, parameters: GatewayUpdate, options?: GatewaysUpdateOptionalParams): Promise<Gateway>

Parameters

resourceGroupName

string

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

gatewayName

string

The name of the Gateway.

parameters

GatewayUpdate

Parameters supplied to the Update gateway operation.

options

GatewaysUpdateOptionalParams

The options parameters.

Returns

Promise<Gateway>