Sites interface

  • Reference
Package:
@azure/arm-hybridnetwork

Interface representing a Sites.

Methods

beginCreateOrUpdate(string, string, Site, SitesCreateOrUpdateOptionalParams)

Creates or updates a network site.
beginCreateOrUpdateAndWait(string, string, Site, SitesCreateOrUpdateOptionalParams)

Creates or updates a network site.
beginDelete(string, string, SitesDeleteOptionalParams)

Deletes the specified network site.
beginDeleteAndWait(string, string, SitesDeleteOptionalParams)

Deletes the specified network site.
get(string, string, SitesGetOptionalParams)

Gets information about the specified network site.
listByResourceGroup(string, SitesListByResourceGroupOptionalParams)

Lists all sites in the network service.
listBySubscription(SitesListBySubscriptionOptionalParams)

Lists all sites in the network service in a subscription.
updateTags(string, string, TagsObject, SitesUpdateTagsOptionalParams)

Updates a site update tags.

Method Details

beginCreateOrUpdate(string, string, Site, SitesCreateOrUpdateOptionalParams)

Creates or updates a network site.

function beginCreateOrUpdate(resourceGroupName: string, siteName: string, parameters: Site, options?: SitesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Site>, Site>>

Parameters

resourceGroupName

string

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

siteName

string

The name of the network service site.

parameters
Site

Parameters supplied to the create or update network site operation.

options
SitesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, Site, SitesCreateOrUpdateOptionalParams)

Creates or updates a network site.

function beginCreateOrUpdateAndWait(resourceGroupName: string, siteName: string, parameters: Site, options?: SitesCreateOrUpdateOptionalParams): Promise<Site>

Parameters

resourceGroupName

string

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

siteName

string

The name of the network service site.

parameters
Site

Parameters supplied to the create or update network site operation.

options
SitesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Site>

beginDelete(string, string, SitesDeleteOptionalParams)

Deletes the specified network site.

function beginDelete(resourceGroupName: string, siteName: string, options?: SitesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<SitesDeleteHeaders>, SitesDeleteHeaders>>

Parameters

resourceGroupName

string

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

siteName

string

The name of the network service site.

options
SitesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, SitesDeleteOptionalParams)

Deletes the specified network site.

function beginDeleteAndWait(resourceGroupName: string, siteName: string, options?: SitesDeleteOptionalParams): Promise<SitesDeleteHeaders>

Parameters

resourceGroupName

string

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

siteName

string

The name of the network service site.

options
SitesDeleteOptionalParams

The options parameters.

Returns

Promise<SitesDeleteHeaders>

get(string, string, SitesGetOptionalParams)

Gets information about the specified network site.

function get(resourceGroupName: string, siteName: string, options?: SitesGetOptionalParams): Promise<Site>

Parameters

resourceGroupName

string

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

siteName

string

The name of the network service site.

options
SitesGetOptionalParams

The options parameters.

Returns

Promise<Site>

listByResourceGroup(string, SitesListByResourceGroupOptionalParams)

Lists all sites in the network service.

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

Parameters

resourceGroupName

string

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

options
SitesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Site, Site[], PageSettings>

listBySubscription(SitesListBySubscriptionOptionalParams)

Lists all sites in the network service in a subscription.

function listBySubscription(options?: SitesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>

Parameters

options
SitesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Site, Site[], PageSettings>

updateTags(string, string, TagsObject, SitesUpdateTagsOptionalParams)

Updates a site update tags.

function updateTags(resourceGroupName: string, siteName: string, parameters: TagsObject, options?: SitesUpdateTagsOptionalParams): Promise<Site>

Parameters

resourceGroupName

string

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

siteName

string

The name of the network service site.

parameters
TagsObject

Parameters supplied to update network site tags.

options
SitesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<Site>