PrivateLinkScopes interface

Package:

@azure/arm-hybridcompute

Interface representing a PrivateLinkScopes.

Methods

beginDelete(string, string, PrivateLinkScopesDeleteOptionalParams)	Deletes a Azure Arc PrivateLinkScope.
beginDeleteAndWait(string, string, PrivateLinkScopesDeleteOptionalParams)	Deletes a Azure Arc PrivateLinkScope.
createOrUpdate(string, string, HybridComputePrivateLinkScope, PrivateLinkScopesCreateOrUpdateOptionalParams)	Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
get(string, string, PrivateLinkScopesGetOptionalParams)	Returns a Azure Arc PrivateLinkScope.
getValidationDetails(string, string, PrivateLinkScopesGetValidationDetailsOptionalParams)	Returns a Azure Arc PrivateLinkScope's validation details.
getValidationDetailsForMachine(string, string, PrivateLinkScopesGetValidationDetailsForMachineOptionalParams)	Returns a Azure Arc PrivateLinkScope's validation details for a given machine.
list(PrivateLinkScopesListOptionalParams)	Gets a list of all Azure Arc PrivateLinkScopes within a subscription.
listByResourceGroup(string, PrivateLinkScopesListByResourceGroupOptionalParams)	Gets a list of Azure Arc PrivateLinkScopes within a resource group.
updateTags(string, string, TagsResource, PrivateLinkScopesUpdateTagsOptionalParams)	Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

Method Details

beginDelete(string, string, PrivateLinkScopesDeleteOptionalParams)

Deletes a Azure Arc PrivateLinkScope.

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

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

options

PrivateLinkScopesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait(string, string, PrivateLinkScopesDeleteOptionalParams)

Deletes a Azure Arc PrivateLinkScope.

function beginDeleteAndWait(resourceGroupName: string, scopeName: string, options?: PrivateLinkScopesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

options

PrivateLinkScopesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, HybridComputePrivateLinkScope, PrivateLinkScopesCreateOrUpdateOptionalParams)

Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

function createOrUpdate(resourceGroupName: string, scopeName: string, parameters: HybridComputePrivateLinkScope, options?: PrivateLinkScopesCreateOrUpdateOptionalParams): Promise<HybridComputePrivateLinkScope>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

parameters

HybridComputePrivateLinkScope

Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope.

options

PrivateLinkScopesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<HybridComputePrivateLinkScope>

get(string, string, PrivateLinkScopesGetOptionalParams)

Returns a Azure Arc PrivateLinkScope.

function get(resourceGroupName: string, scopeName: string, options?: PrivateLinkScopesGetOptionalParams): Promise<HybridComputePrivateLinkScope>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

options

PrivateLinkScopesGetOptionalParams

The options parameters.

Returns

Promise<HybridComputePrivateLinkScope>

getValidationDetails(string, string, PrivateLinkScopesGetValidationDetailsOptionalParams)

Returns a Azure Arc PrivateLinkScope's validation details.

function getValidationDetails(location: string, privateLinkScopeId: string, options?: PrivateLinkScopesGetValidationDetailsOptionalParams): Promise<PrivateLinkScopeValidationDetails>

Parameters

location

string

The location of the target resource.

privateLinkScopeId

string

The id (Guid) of the Azure Arc PrivateLinkScope resource.

options

PrivateLinkScopesGetValidationDetailsOptionalParams

The options parameters.

Returns

Promise<PrivateLinkScopeValidationDetails>

getValidationDetailsForMachine(string, string, PrivateLinkScopesGetValidationDetailsForMachineOptionalParams)

Returns a Azure Arc PrivateLinkScope's validation details for a given machine.

function getValidationDetailsForMachine(resourceGroupName: string, machineName: string, options?: PrivateLinkScopesGetValidationDetailsForMachineOptionalParams): Promise<PrivateLinkScopeValidationDetails>

Parameters

resourceGroupName

string

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

machineName

string

The name of the target machine to get the private link scope validation details for.

options

PrivateLinkScopesGetValidationDetailsForMachineOptionalParams

The options parameters.

Returns

Promise<PrivateLinkScopeValidationDetails>

list(PrivateLinkScopesListOptionalParams)

Gets a list of all Azure Arc PrivateLinkScopes within a subscription.

function list(options?: PrivateLinkScopesListOptionalParams): PagedAsyncIterableIterator<HybridComputePrivateLinkScope, HybridComputePrivateLinkScope[], PageSettings>

Parameters

options

PrivateLinkScopesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HybridComputePrivateLinkScope, HybridComputePrivateLinkScope[], PageSettings>

listByResourceGroup(string, PrivateLinkScopesListByResourceGroupOptionalParams)

Gets a list of Azure Arc PrivateLinkScopes within a resource group.

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

Parameters

resourceGroupName

string

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

options

PrivateLinkScopesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<HybridComputePrivateLinkScope, HybridComputePrivateLinkScope[], PageSettings>

updateTags(string, string, TagsResource, PrivateLinkScopesUpdateTagsOptionalParams)

Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

function updateTags(resourceGroupName: string, scopeName: string, privateLinkScopeTags: TagsResource, options?: PrivateLinkScopesUpdateTagsOptionalParams): Promise<HybridComputePrivateLinkScope>

Parameters

resourceGroupName

string

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

scopeName

string

The name of the Azure Arc PrivateLinkScope resource.

privateLinkScopeTags

TagsResource

Updated tag information to set into the PrivateLinkScope instance.

options

PrivateLinkScopesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<HybridComputePrivateLinkScope>