Share via

Hubs interface

  • Reference
Package:
@azure/arm-customerinsights

Interface representing a Hubs.

Methods

beginDelete(string, string, HubsDeleteOptionalParams)

Deletes the specified hub.
beginDeleteAndWait(string, string, HubsDeleteOptionalParams)

Deletes the specified hub.
createOrUpdate(string, string, Hub, HubsCreateOrUpdateOptionalParams)

Creates a hub, or updates an existing hub.
get(string, string, HubsGetOptionalParams)

Gets information about the specified hub.
list(HubsListOptionalParams)

Gets all hubs in the specified subscription.
listByResourceGroup(string, HubsListByResourceGroupOptionalParams)

Gets all the hubs in a resource group.
update(string, string, Hub, HubsUpdateOptionalParams)

Updates a Hub.

Method Details

beginDelete(string, string, HubsDeleteOptionalParams)

Deletes the specified hub.

function beginDelete(resourceGroupName: string, hubName: string, options?: HubsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

options
HubsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, HubsDeleteOptionalParams)

Deletes the specified hub.

function beginDeleteAndWait(resourceGroupName: string, hubName: string, options?: HubsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

options
HubsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, Hub, HubsCreateOrUpdateOptionalParams)

Creates a hub, or updates an existing hub.

function createOrUpdate(resourceGroupName: string, hubName: string, parameters: Hub, options?: HubsCreateOrUpdateOptionalParams): Promise<Hub>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the Hub.

parameters
Hub

Parameters supplied to the CreateOrUpdate Hub operation.

options
HubsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Hub>

get(string, string, HubsGetOptionalParams)

Gets information about the specified hub.

function get(resourceGroupName: string, hubName: string, options?: HubsGetOptionalParams): Promise<Hub>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

options
HubsGetOptionalParams

The options parameters.

Returns

Promise<Hub>

list(HubsListOptionalParams)

Gets all hubs in the specified subscription.

function list(options?: HubsListOptionalParams): PagedAsyncIterableIterator<Hub, Hub[], PageSettings>

Parameters

options
HubsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Hub, Hub[], PageSettings>

listByResourceGroup(string, HubsListByResourceGroupOptionalParams)

Gets all the hubs in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options
HubsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Hub, Hub[], PageSettings>

update(string, string, Hub, HubsUpdateOptionalParams)

Updates a Hub.

function update(resourceGroupName: string, hubName: string, parameters: Hub, options?: HubsUpdateOptionalParams): Promise<Hub>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the Hub.

parameters
Hub

Parameters supplied to the Update Hub operation.

options
HubsUpdateOptionalParams

The options parameters.

Returns

Promise<Hub>