CommunicationsGateways interface

Interface representing a CommunicationsGateways.

Methods

beginCreateOrUpdate(string, string, CommunicationsGateway, CommunicationsGatewaysCreateOrUpdateOptionalParams)

Create a CommunicationsGateway

beginCreateOrUpdateAndWait(string, string, CommunicationsGateway, CommunicationsGatewaysCreateOrUpdateOptionalParams)

Create a CommunicationsGateway

beginDelete(string, string, CommunicationsGatewaysDeleteOptionalParams)

Delete a CommunicationsGateway

beginDeleteAndWait(string, string, CommunicationsGatewaysDeleteOptionalParams)

Delete a CommunicationsGateway

get(string, string, CommunicationsGatewaysGetOptionalParams)

Get a CommunicationsGateway

listByResourceGroup(string, CommunicationsGatewaysListByResourceGroupOptionalParams)

List CommunicationsGateway resources by resource group

listBySubscription(CommunicationsGatewaysListBySubscriptionOptionalParams)

List CommunicationsGateway resources by subscription ID

update(string, string, CommunicationsGatewayUpdate, CommunicationsGatewaysUpdateOptionalParams)

Update a CommunicationsGateway

Method Details

beginCreateOrUpdate(string, string, CommunicationsGateway, CommunicationsGatewaysCreateOrUpdateOptionalParams)

Create a CommunicationsGateway

function beginCreateOrUpdate(resourceGroupName: string, communicationsGatewayName: string, resource: CommunicationsGateway, options?: CommunicationsGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CommunicationsGateway>, CommunicationsGateway>>

Parameters

resourceGroupName

string

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

communicationsGatewayName

string

Unique identifier for this deployment

resource
CommunicationsGateway

Resource create parameters.

options
CommunicationsGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, CommunicationsGateway, CommunicationsGatewaysCreateOrUpdateOptionalParams)

Create a CommunicationsGateway

function beginCreateOrUpdateAndWait(resourceGroupName: string, communicationsGatewayName: string, resource: CommunicationsGateway, options?: CommunicationsGatewaysCreateOrUpdateOptionalParams): Promise<CommunicationsGateway>

Parameters

resourceGroupName

string

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

communicationsGatewayName

string

Unique identifier for this deployment

resource
CommunicationsGateway

Resource create parameters.

options
CommunicationsGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, CommunicationsGatewaysDeleteOptionalParams)

Delete a CommunicationsGateway

function beginDelete(resourceGroupName: string, communicationsGatewayName: string, options?: CommunicationsGatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

communicationsGatewayName

string

Unique identifier for this deployment

options
CommunicationsGatewaysDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, CommunicationsGatewaysDeleteOptionalParams)

Delete a CommunicationsGateway

function beginDeleteAndWait(resourceGroupName: string, communicationsGatewayName: string, options?: CommunicationsGatewaysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

communicationsGatewayName

string

Unique identifier for this deployment

options
CommunicationsGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, CommunicationsGatewaysGetOptionalParams)

Get a CommunicationsGateway

function get(resourceGroupName: string, communicationsGatewayName: string, options?: CommunicationsGatewaysGetOptionalParams): Promise<CommunicationsGateway>

Parameters

resourceGroupName

string

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

communicationsGatewayName

string

Unique identifier for this deployment

options
CommunicationsGatewaysGetOptionalParams

The options parameters.

Returns

listByResourceGroup(string, CommunicationsGatewaysListByResourceGroupOptionalParams)

List CommunicationsGateway resources by resource group

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

Parameters

resourceGroupName

string

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

Returns

listBySubscription(CommunicationsGatewaysListBySubscriptionOptionalParams)

List CommunicationsGateway resources by subscription ID

function listBySubscription(options?: CommunicationsGatewaysListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CommunicationsGateway, CommunicationsGateway[], PageSettings>

Parameters

Returns

update(string, string, CommunicationsGatewayUpdate, CommunicationsGatewaysUpdateOptionalParams)

Update a CommunicationsGateway

function update(resourceGroupName: string, communicationsGatewayName: string, properties: CommunicationsGatewayUpdate, options?: CommunicationsGatewaysUpdateOptionalParams): Promise<CommunicationsGateway>

Parameters

resourceGroupName

string

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

communicationsGatewayName

string

Unique identifier for this deployment

properties
CommunicationsGatewayUpdate

The resource properties to be updated.

options
CommunicationsGatewaysUpdateOptionalParams

The options parameters.

Returns