PrivateLinkServicesOperations interface

Package:
@azure/arm-network

Interface representing a PrivateLinkServices operations.

Properties

beginCheckPrivateLinkServiceVisibility
beginCheckPrivateLinkServiceVisibilityAndWait
beginCheckPrivateLinkServiceVisibilityByResourceGroup
beginCheckPrivateLinkServiceVisibilityByResourceGroupAndWait
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginDeletePrivateEndpointConnection
beginDeletePrivateEndpointConnectionAndWait
checkPrivateLinkServiceVisibility

Checks whether the subscription is visible to private link service.
checkPrivateLinkServiceVisibilityByResourceGroup

Checks whether the subscription is visible to private link service in the specified resource group.
createOrUpdate

Creates or updates an private link service in the specified resource group.
delete

Deletes the specified private link service.
deletePrivateEndpointConnection

Delete private end point connection for a private link service in a subscription.
get

Gets the specified private link service by resource group.
getPrivateEndpointConnection

Get the specific private end point connection by specific private link service in the resource group.
list

Gets all private link services in a resource group.
listAutoApprovedPrivateLinkServices

Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.
listAutoApprovedPrivateLinkServicesByResourceGroup

Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.
listBySubscription

Gets all private link service in a subscription.
listPrivateEndpointConnections

Gets all private end point connections for a specific private link service.
updatePrivateEndpointConnection

Approve or reject private end point connection for a private link service in a subscription.

Property Details

beginCheckPrivateLinkServiceVisibility

Warning

This API is now deprecated.

use checkPrivateLinkServiceVisibility instead

beginCheckPrivateLinkServiceVisibility: (location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>>

Property Value

(location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>>

beginCheckPrivateLinkServiceVisibilityAndWait

Warning

This API is now deprecated.

use checkPrivateLinkServiceVisibility instead

beginCheckPrivateLinkServiceVisibilityAndWait: (location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams) => Promise<PrivateLinkServiceVisibility>

Property Value

(location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams) => Promise<PrivateLinkServiceVisibility>

beginCheckPrivateLinkServiceVisibilityByResourceGroup

Warning

This API is now deprecated.

use checkPrivateLinkServiceVisibilityByResourceGroup instead

beginCheckPrivateLinkServiceVisibilityByResourceGroup: (resourceGroupName: string, location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>>

Property Value

(resourceGroupName: string, location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>>

beginCheckPrivateLinkServiceVisibilityByResourceGroupAndWait

Warning

This API is now deprecated.

use checkPrivateLinkServiceVisibilityByResourceGroup instead

beginCheckPrivateLinkServiceVisibilityByResourceGroupAndWait: (resourceGroupName: string, location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams) => Promise<PrivateLinkServiceVisibility>

Property Value

(resourceGroupName: string, location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams) => Promise<PrivateLinkServiceVisibility>

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, serviceName: string, parameters: PrivateLinkService, options?: PrivateLinkServicesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateLinkService>, PrivateLinkService>>

Property Value

(resourceGroupName: string, serviceName: string, parameters: PrivateLinkService, options?: PrivateLinkServicesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateLinkService>, PrivateLinkService>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, serviceName: string, parameters: PrivateLinkService, options?: PrivateLinkServicesCreateOrUpdateOptionalParams) => Promise<PrivateLinkService>

Property Value

(resourceGroupName: string, serviceName: string, parameters: PrivateLinkService, options?: PrivateLinkServicesCreateOrUpdateOptionalParams) => Promise<PrivateLinkService>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesDeleteOptionalParams) => Promise<void>

beginDeletePrivateEndpointConnection

Warning

This API is now deprecated.

use deletePrivateEndpointConnection instead

beginDeletePrivateEndpointConnection: (resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeletePrivateEndpointConnectionAndWait

Warning

This API is now deprecated.

use deletePrivateEndpointConnection instead

beginDeletePrivateEndpointConnectionAndWait: (resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams) => Promise<void>

checkPrivateLinkServiceVisibility

Checks whether the subscription is visible to private link service.

checkPrivateLinkServiceVisibility: (location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams) => PollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>

Property Value

(location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams) => PollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>

checkPrivateLinkServiceVisibilityByResourceGroup

Checks whether the subscription is visible to private link service in the specified resource group.

checkPrivateLinkServiceVisibilityByResourceGroup: (resourceGroupName: string, location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams) => PollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>

Property Value

(resourceGroupName: string, location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams) => PollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>

createOrUpdate

Creates or updates an private link service in the specified resource group.

createOrUpdate: (resourceGroupName: string, serviceName: string, parameters: PrivateLinkService, options?: PrivateLinkServicesCreateOrUpdateOptionalParams) => PollerLike<OperationState<PrivateLinkService>, PrivateLinkService>

Property Value

(resourceGroupName: string, serviceName: string, parameters: PrivateLinkService, options?: PrivateLinkServicesCreateOrUpdateOptionalParams) => PollerLike<OperationState<PrivateLinkService>, PrivateLinkService>

delete

Deletes the specified private link service.

delete: (resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

deletePrivateEndpointConnection

Delete private end point connection for a private link service in a subscription.

deletePrivateEndpointConnection: (resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the specified private link service by resource group.

get: (resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesGetOptionalParams) => Promise<PrivateLinkService>

Property Value

(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesGetOptionalParams) => Promise<PrivateLinkService>

getPrivateEndpointConnection

Get the specific private end point connection by specific private link service in the resource group.

getPrivateEndpointConnection: (resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesGetPrivateEndpointConnectionOptionalParams) => Promise<PrivateEndpointConnection>

Property Value

(resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesGetPrivateEndpointConnectionOptionalParams) => Promise<PrivateEndpointConnection>

list

Gets all private link services in a resource group.

list: (resourceGroupName: string, options?: PrivateLinkServicesListOptionalParams) => PagedAsyncIterableIterator<PrivateLinkService, PrivateLinkService[], PageSettings>

Property Value

(resourceGroupName: string, options?: PrivateLinkServicesListOptionalParams) => PagedAsyncIterableIterator<PrivateLinkService, PrivateLinkService[], PageSettings>

listAutoApprovedPrivateLinkServices

Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.

listAutoApprovedPrivateLinkServices: (location: string, options?: PrivateLinkServicesListAutoApprovedPrivateLinkServicesOptionalParams) => PagedAsyncIterableIterator<AutoApprovedPrivateLinkService, AutoApprovedPrivateLinkService[], PageSettings>

Property Value

(location: string, options?: PrivateLinkServicesListAutoApprovedPrivateLinkServicesOptionalParams) => PagedAsyncIterableIterator<AutoApprovedPrivateLinkService, AutoApprovedPrivateLinkService[], PageSettings>

listAutoApprovedPrivateLinkServicesByResourceGroup

Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.

listAutoApprovedPrivateLinkServicesByResourceGroup: (resourceGroupName: string, location: string, options?: PrivateLinkServicesListAutoApprovedPrivateLinkServicesByResourceGroupOptionalParams) => PagedAsyncIterableIterator<AutoApprovedPrivateLinkService, AutoApprovedPrivateLinkService[], PageSettings>

Property Value

(resourceGroupName: string, location: string, options?: PrivateLinkServicesListAutoApprovedPrivateLinkServicesByResourceGroupOptionalParams) => PagedAsyncIterableIterator<AutoApprovedPrivateLinkService, AutoApprovedPrivateLinkService[], PageSettings>

listBySubscription

Gets all private link service in a subscription.

listBySubscription: (options?: PrivateLinkServicesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<PrivateLinkService, PrivateLinkService[], PageSettings>

Property Value

(options?: PrivateLinkServicesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<PrivateLinkService, PrivateLinkService[], PageSettings>

listPrivateEndpointConnections

Gets all private end point connections for a specific private link service.

listPrivateEndpointConnections: (resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesListPrivateEndpointConnectionsOptionalParams) => PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Property Value

(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesListPrivateEndpointConnectionsOptionalParams) => PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

updatePrivateEndpointConnection

Approve or reject private end point connection for a private link service in a subscription.

updatePrivateEndpointConnection: (resourceGroupName: string, serviceName: string, peConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateLinkServicesUpdatePrivateEndpointConnectionOptionalParams) => Promise<PrivateEndpointConnection>

Property Value

(resourceGroupName: string, serviceName: string, peConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateLinkServicesUpdatePrivateEndpointConnectionOptionalParams) => Promise<PrivateEndpointConnection>