Package version:

InterfacePrivateLinkScopes

Interface representing a PrivateLinkScopes.

interface PrivateLinkScopes {
    beginDelete(resourceGroupName: string, scopeName: string, options?: PrivateLinkScopesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, scopeName: string, options?: PrivateLinkScopesDeleteOptionalParams): Promise<void>;
    createOrUpdate(resourceGroupName: string, scopeName: string, parameters: HybridComputePrivateLinkScope, options?: PrivateLinkScopesCreateOrUpdateOptionalParams): Promise<HybridComputePrivateLinkScope>;
    get(resourceGroupName: string, scopeName: string, options?: PrivateLinkScopesGetOptionalParams): Promise<HybridComputePrivateLinkScope>;
    getValidationDetails(location: string, privateLinkScopeId: string, options?: PrivateLinkScopesGetValidationDetailsOptionalParams): Promise<PrivateLinkScopeValidationDetails>;
    getValidationDetailsForMachine(resourceGroupName: string, machineName: string, options?: PrivateLinkScopesGetValidationDetailsForMachineOptionalParams): Promise<PrivateLinkScopeValidationDetails>;
    list(options?: PrivateLinkScopesListOptionalParams): PagedAsyncIterableIterator<HybridComputePrivateLinkScope>;
    listByResourceGroup(resourceGroupName: string, options?: PrivateLinkScopesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<HybridComputePrivateLinkScope>;
    updateTags(resourceGroupName: string, scopeName: string, privateLinkScopeTags: TagsResource, options?: PrivateLinkScopesUpdateTagsOptionalParams): Promise<HybridComputePrivateLinkScope>;
}

Index

Methods

beginDelete beginDeleteAndWait createOrUpdate get getValidationDetails getValidationDetailsForMachine list listByResourceGroup updateTags

Methods

beginDelete

beginDelete(resourceGroupName, scopeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a Azure Arc PrivateLinkScope.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- scopeName: string
  The name of the Azure Arc PrivateLinkScope resource.
- Optionaloptions: PrivateLinkScopesDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/privateLinkScopes.ts:54

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, scopeName, options?): Promise<void>
Deletes a Azure Arc PrivateLinkScope.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- scopeName: string
  The name of the Azure Arc PrivateLinkScope resource.
- Optionaloptions: PrivateLinkScopesDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/privateLinkScopes.ts:65

createOrUpdate

createOrUpdate(resourceGroupName, scopeName, parameters, options?): Promise<HybridComputePrivateLinkScope>
Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
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.
- Optionaloptions: PrivateLinkScopesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<HybridComputePrivateLinkScope>
- Defined in operationsInterfaces/privateLinkScopes.ts:90

get

get(resourceGroupName, scopeName, options?): Promise<HybridComputePrivateLinkScope>
Returns a Azure Arc PrivateLinkScope.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- scopeName: string
  The name of the Azure Arc PrivateLinkScope resource.
- Optionaloptions: PrivateLinkScopesGetOptionalParams
  The options parameters.
Returns Promise<HybridComputePrivateLinkScope>
- Defined in operationsInterfaces/privateLinkScopes.ts:76

getValidationDetails

getValidationDetails(location, privateLinkScopeId, options?): Promise<PrivateLinkScopeValidationDetails>
Returns a Azure Arc PrivateLinkScope's validation details.
Parameters
- location: string
  The location of the target resource.
- privateLinkScopeId: string
  The id (Guid) of the Azure Arc PrivateLinkScope resource.
- Optionaloptions: PrivateLinkScopesGetValidationDetailsOptionalParams
  The options parameters.
Returns Promise<PrivateLinkScopeValidationDetails>
- Defined in operationsInterfaces/privateLinkScopes.ts:115

getValidationDetailsForMachine

getValidationDetailsForMachine(resourceGroupName, machineName, options?): Promise<PrivateLinkScopeValidationDetails>
Returns a Azure Arc PrivateLinkScope's validation details for a given machine.
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.
- Optionaloptions: PrivateLinkScopesGetValidationDetailsForMachineOptionalParams
  The options parameters.
Returns Promise<PrivateLinkScopeValidationDetails>
- Defined in operationsInterfaces/privateLinkScopes.ts:127

list

list(options?): PagedAsyncIterableIterator<HybridComputePrivateLinkScope>
Gets a list of all Azure Arc PrivateLinkScopes within a subscription.
Parameters
- Optionaloptions: PrivateLinkScopesListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<HybridComputePrivateLinkScope>
- Defined in operationsInterfaces/privateLinkScopes.ts:36

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<HybridComputePrivateLinkScope>
Gets a list of Azure Arc PrivateLinkScopes within a resource group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- Optionaloptions: PrivateLinkScopesListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<HybridComputePrivateLinkScope>
- Defined in operationsInterfaces/privateLinkScopes.ts:44

updateTags

updateTags(resourceGroupName, scopeName, privateLinkScopeTags, options?): Promise<HybridComputePrivateLinkScope>
Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.
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.
- Optionaloptions: PrivateLinkScopesUpdateTagsOptionalParams
  The options parameters.
Returns Promise<HybridComputePrivateLinkScope>
- Defined in operationsInterfaces/privateLinkScopes.ts:103

InterfacePrivateLinkScopes

Index

Methods

Methods

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

createOrUpdate

Parameters

Returns Promise<HybridComputePrivateLinkScope>

get

Parameters

Returns Promise<HybridComputePrivateLinkScope>

getValidationDetails

Parameters

Returns Promise<PrivateLinkScopeValidationDetails>

getValidationDetailsForMachine

Parameters

Returns Promise<PrivateLinkScopeValidationDetails>

list

Parameters

Returns PagedAsyncIterableIterator<HybridComputePrivateLinkScope>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<HybridComputePrivateLinkScope>

updateTags

Parameters

Returns Promise<HybridComputePrivateLinkScope>

Settings