Share via


PrivateLinkScopes interface

Interface representing a PrivateLinkScopes.

Methods

createOrUpdate(string, string, KubernetesConfigurationPrivateLinkScope, PrivateLinkScopesCreateOrUpdateOptionalParams)

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

delete(string, string, PrivateLinkScopesDeleteOptionalParams)

Deletes a Azure Arc PrivateLinkScope.

get(string, string, PrivateLinkScopesGetOptionalParams)

Returns a Azure Arc PrivateLinkScope.

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

createOrUpdate(string, string, KubernetesConfigurationPrivateLinkScope, 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: KubernetesConfigurationPrivateLinkScope, options?: PrivateLinkScopesCreateOrUpdateOptionalParams): Promise<KubernetesConfigurationPrivateLinkScope>

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
KubernetesConfigurationPrivateLinkScope

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

options
PrivateLinkScopesCreateOrUpdateOptionalParams

The options parameters.

Returns

delete(string, string, PrivateLinkScopesDeleteOptionalParams)

Deletes a Azure Arc PrivateLinkScope.

function delete(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>

get(string, string, PrivateLinkScopesGetOptionalParams)

Returns a Azure Arc PrivateLinkScope.

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

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

list(PrivateLinkScopesListOptionalParams)

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

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

Parameters

options
PrivateLinkScopesListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, PrivateLinkScopesListByResourceGroupOptionalParams)

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

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

Parameters

resourceGroupName

string

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

options
PrivateLinkScopesListByResourceGroupOptionalParams

The options parameters.

Returns

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<KubernetesConfigurationPrivateLinkScope>

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