IpCommunities interface

Package:

@azure/arm-managednetworkfabric

Interface representing a IpCommunities.

Methods

beginCreate(string, string, IpCommunity, IpCommunitiesCreateOptionalParams)	Implements an IP Community PUT method.
beginCreateAndWait(string, string, IpCommunity, IpCommunitiesCreateOptionalParams)	Implements an IP Community PUT method.
beginDelete(string, string, IpCommunitiesDeleteOptionalParams)	Implements IP Community DELETE method.
beginDeleteAndWait(string, string, IpCommunitiesDeleteOptionalParams)	Implements IP Community DELETE method.
beginUpdate(string, string, IpCommunityPatch, IpCommunitiesUpdateOptionalParams)	API to update certain properties of the IP Community resource.
beginUpdateAndWait(string, string, IpCommunityPatch, IpCommunitiesUpdateOptionalParams)	API to update certain properties of the IP Community resource.
get(string, string, IpCommunitiesGetOptionalParams)	Implements an IP Community GET method.
listByResourceGroup(string, IpCommunitiesListByResourceGroupOptionalParams)	Implements IP Communities list by resource group GET method.
listBySubscription(IpCommunitiesListBySubscriptionOptionalParams)	Implements IP Communities list by subscription GET method.

Method Details

beginCreate(string, string, IpCommunity, IpCommunitiesCreateOptionalParams)

Implements an IP Community PUT method.

function beginCreate(resourceGroupName: string, ipCommunityName: string, body: IpCommunity, options?: IpCommunitiesCreateOptionalParams): Promise<SimplePollerLike<OperationState<IpCommunity>, IpCommunity>>

Parameters

resourceGroupName

string

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

ipCommunityName

string

Name of the IP Community.

body

IpCommunity

Request payload.

options

IpCommunitiesCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, IpCommunity, IpCommunitiesCreateOptionalParams)

Implements an IP Community PUT method.

function beginCreateAndWait(resourceGroupName: string, ipCommunityName: string, body: IpCommunity, options?: IpCommunitiesCreateOptionalParams): Promise<IpCommunity>

Parameters

resourceGroupName

string

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

ipCommunityName

string

Name of the IP Community.

body

IpCommunity

Request payload.

options

IpCommunitiesCreateOptionalParams

The options parameters.

Returns

Promise<IpCommunity>

beginDelete(string, string, IpCommunitiesDeleteOptionalParams)

Implements IP Community DELETE method.

function beginDelete(resourceGroupName: string, ipCommunityName: string, options?: IpCommunitiesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IpCommunitiesDeleteHeaders>, IpCommunitiesDeleteHeaders>>

Parameters

resourceGroupName

string

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

ipCommunityName

string

Name of the IP Community.

options

IpCommunitiesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, IpCommunitiesDeleteOptionalParams)

Implements IP Community DELETE method.

function beginDeleteAndWait(resourceGroupName: string, ipCommunityName: string, options?: IpCommunitiesDeleteOptionalParams): Promise<IpCommunitiesDeleteHeaders>

Parameters

resourceGroupName

string

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

ipCommunityName

string

Name of the IP Community.

options

IpCommunitiesDeleteOptionalParams

The options parameters.

Returns

Promise<IpCommunitiesDeleteHeaders>

beginUpdate(string, string, IpCommunityPatch, IpCommunitiesUpdateOptionalParams)

API to update certain properties of the IP Community resource.

function beginUpdate(resourceGroupName: string, ipCommunityName: string, body: IpCommunityPatch, options?: IpCommunitiesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IpCommunity>, IpCommunity>>

Parameters

resourceGroupName

string

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

ipCommunityName

string

Name of the IP Community.

body

IpCommunityPatch

IP Community properties to update.

options

IpCommunitiesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, IpCommunityPatch, IpCommunitiesUpdateOptionalParams)

API to update certain properties of the IP Community resource.

function beginUpdateAndWait(resourceGroupName: string, ipCommunityName: string, body: IpCommunityPatch, options?: IpCommunitiesUpdateOptionalParams): Promise<IpCommunity>

Parameters

resourceGroupName

string

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

ipCommunityName

string

Name of the IP Community.

body

IpCommunityPatch

IP Community properties to update.

options

IpCommunitiesUpdateOptionalParams

The options parameters.

Returns

Promise<IpCommunity>

get(string, string, IpCommunitiesGetOptionalParams)

Implements an IP Community GET method.

function get(resourceGroupName: string, ipCommunityName: string, options?: IpCommunitiesGetOptionalParams): Promise<IpCommunity>

Parameters

resourceGroupName

string

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

ipCommunityName

string

Name of the IP Community.

options

IpCommunitiesGetOptionalParams

The options parameters.

Returns

Promise<IpCommunity>

listByResourceGroup(string, IpCommunitiesListByResourceGroupOptionalParams)

Implements IP Communities list by resource group GET method.

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

Parameters

resourceGroupName

string

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

options

IpCommunitiesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IpCommunity, IpCommunity[], PageSettings>

listBySubscription(IpCommunitiesListBySubscriptionOptionalParams)

Implements IP Communities list by subscription GET method.

function listBySubscription(options?: IpCommunitiesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IpCommunity, IpCommunity[], PageSettings>

Parameters

options

IpCommunitiesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IpCommunity, IpCommunity[], PageSettings>