PrivateLinkHubs interface

Package:

@azure/arm-synapse

Interface representing a PrivateLinkHubs.

Methods

beginDelete(string, string, PrivateLinkHubsDeleteOptionalParams)	Deletes a privateLinkHub
beginDeleteAndWait(string, string, PrivateLinkHubsDeleteOptionalParams)	Deletes a privateLinkHub
createOrUpdate(string, string, PrivateLinkHub, PrivateLinkHubsCreateOrUpdateOptionalParams)	Creates or updates a privateLinkHub
get(string, string, PrivateLinkHubsGetOptionalParams)	Gets a privateLinkHub
list(PrivateLinkHubsListOptionalParams)	Returns a list of privateLinkHubs in a subscription
listByResourceGroup(string, PrivateLinkHubsListByResourceGroupOptionalParams)	Returns a list of privateLinkHubs in a resource group
update(string, string, PrivateLinkHubPatchInfo, PrivateLinkHubsUpdateOptionalParams)	Updates a privateLinkHub

Method Details

beginDelete(string, string, PrivateLinkHubsDeleteOptionalParams)

Deletes a privateLinkHub

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

Parameters

resourceGroupName

string

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

privateLinkHubName

string

Name of the privateLinkHub

options

PrivateLinkHubsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, PrivateLinkHubsDeleteOptionalParams)

Deletes a privateLinkHub

function beginDeleteAndWait(resourceGroupName: string, privateLinkHubName: string, options?: PrivateLinkHubsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

privateLinkHubName

string

Name of the privateLinkHub

options

PrivateLinkHubsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, PrivateLinkHub, PrivateLinkHubsCreateOrUpdateOptionalParams)

Creates or updates a privateLinkHub

function createOrUpdate(resourceGroupName: string, privateLinkHubName: string, privateLinkHubInfo: PrivateLinkHub, options?: PrivateLinkHubsCreateOrUpdateOptionalParams): Promise<PrivateLinkHub>

Parameters

resourceGroupName

string

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

privateLinkHubName

string

Name of the privateLinkHub

privateLinkHubInfo

PrivateLinkHub

PrivateLinkHub create or update request properties

options

PrivateLinkHubsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateLinkHub>

get(string, string, PrivateLinkHubsGetOptionalParams)

Gets a privateLinkHub

function get(resourceGroupName: string, privateLinkHubName: string, options?: PrivateLinkHubsGetOptionalParams): Promise<PrivateLinkHub>

Parameters

resourceGroupName

string

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

privateLinkHubName

string

Name of the privateLinkHub

options

PrivateLinkHubsGetOptionalParams

The options parameters.

Returns

Promise<PrivateLinkHub>

list(PrivateLinkHubsListOptionalParams)

Returns a list of privateLinkHubs in a subscription

function list(options?: PrivateLinkHubsListOptionalParams): PagedAsyncIterableIterator<PrivateLinkHub, PrivateLinkHub[], PageSettings>

Parameters

options

PrivateLinkHubsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateLinkHub, PrivateLinkHub[], PageSettings>

listByResourceGroup(string, PrivateLinkHubsListByResourceGroupOptionalParams)

Returns a list of privateLinkHubs in a resource group

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

Parameters

resourceGroupName

string

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

options

PrivateLinkHubsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateLinkHub, PrivateLinkHub[], PageSettings>

update(string, string, PrivateLinkHubPatchInfo, PrivateLinkHubsUpdateOptionalParams)

Updates a privateLinkHub

function update(resourceGroupName: string, privateLinkHubName: string, privateLinkHubPatchInfo: PrivateLinkHubPatchInfo, options?: PrivateLinkHubsUpdateOptionalParams): Promise<PrivateLinkHub>

Parameters

resourceGroupName

string

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

privateLinkHubName

string

Name of the privateLinkHub

privateLinkHubPatchInfo

PrivateLinkHubPatchInfo

PrivateLinkHub patch request properties

options

PrivateLinkHubsUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateLinkHub>