PrivateLinkServices interface
Interface representing a PrivateLinkServices.
Methods
Method Details
beginCheckPrivateLinkServiceVisibility(string, CheckPrivateLinkServiceVisibilityRequest, PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams)
Checks whether the subscription is visible to private link service.
function beginCheckPrivateLinkServiceVisibility(location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams): Promise<SimplePollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>>Parameters
- location
-
string
The location of the domain name.
- parameters
- CheckPrivateLinkServiceVisibilityRequest
The request body of CheckPrivateLinkService API call.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>>
beginCheckPrivateLinkServiceVisibilityAndWait(string, CheckPrivateLinkServiceVisibilityRequest, PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams)
Checks whether the subscription is visible to private link service.
function beginCheckPrivateLinkServiceVisibilityAndWait(location: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityOptionalParams): Promise<PrivateLinkServiceVisibility>Parameters
- location
-
string
The location of the domain name.
- parameters
- CheckPrivateLinkServiceVisibilityRequest
The request body of CheckPrivateLinkService API call.
The options parameters.
Returns
Promise<PrivateLinkServiceVisibility>
beginCheckPrivateLinkServiceVisibilityByResourceGroup(string, string, CheckPrivateLinkServiceVisibilityRequest, PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams)
Checks whether the subscription is visible to private link service in the specified resource group.
function beginCheckPrivateLinkServiceVisibilityByResourceGroup(location: string, resourceGroupName: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>>Parameters
- location
-
string
The location of the domain name.
- resourceGroupName
-
string
The name of the resource group.
- parameters
- CheckPrivateLinkServiceVisibilityRequest
The request body of CheckPrivateLinkService API call.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateLinkServiceVisibility>, PrivateLinkServiceVisibility>>
beginCheckPrivateLinkServiceVisibilityByResourceGroupAndWait(string, string, CheckPrivateLinkServiceVisibilityRequest, PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams)
Checks whether the subscription is visible to private link service in the specified resource group.
function beginCheckPrivateLinkServiceVisibilityByResourceGroupAndWait(location: string, resourceGroupName: string, parameters: CheckPrivateLinkServiceVisibilityRequest, options?: PrivateLinkServicesCheckPrivateLinkServiceVisibilityByResourceGroupOptionalParams): Promise<PrivateLinkServiceVisibility>Parameters
- location
-
string
The location of the domain name.
- resourceGroupName
-
string
The name of the resource group.
- parameters
- CheckPrivateLinkServiceVisibilityRequest
The request body of CheckPrivateLinkService API call.
The options parameters.
Returns
Promise<PrivateLinkServiceVisibility>
beginCreateOrUpdate(string, string, PrivateLinkService, PrivateLinkServicesCreateOrUpdateOptionalParams)
Creates or updates an private link service in the specified resource group.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: PrivateLinkService, options?: PrivateLinkServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateLinkService>, PrivateLinkService>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
- parameters
- PrivateLinkService
Parameters supplied to the create or update private link service operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateLinkService>, PrivateLinkService>>
beginCreateOrUpdateAndWait(string, string, PrivateLinkService, PrivateLinkServicesCreateOrUpdateOptionalParams)
Creates or updates an private link service in the specified resource group.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: PrivateLinkService, options?: PrivateLinkServicesCreateOrUpdateOptionalParams): Promise<PrivateLinkService>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
- parameters
- PrivateLinkService
Parameters supplied to the create or update private link service operation.
The options parameters.
Returns
Promise<PrivateLinkService>
beginDelete(string, string, PrivateLinkServicesDeleteOptionalParams)
Deletes the specified private link service.
function beginDelete(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, PrivateLinkServicesDeleteOptionalParams)
Deletes the specified private link service.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
The options parameters.
Returns
Promise<void>
beginDeletePrivateEndpointConnection(string, string, string, PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams)
Delete private end point connection for a private link service in a subscription.
function beginDeletePrivateEndpointConnection(resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
- peConnectionName
-
string
The name of the private end point connection.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeletePrivateEndpointConnectionAndWait(string, string, string, PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams)
Delete private end point connection for a private link service in a subscription.
function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesDeletePrivateEndpointConnectionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
- peConnectionName
-
string
The name of the private end point connection.
The options parameters.
Returns
Promise<void>
get(string, string, PrivateLinkServicesGetOptionalParams)
Gets the specified private link service by resource group.
function get(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesGetOptionalParams): Promise<PrivateLinkService>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
The options parameters.
Returns
Promise<PrivateLinkService>
getPrivateEndpointConnection(string, string, string, PrivateLinkServicesGetPrivateEndpointConnectionOptionalParams)
Get the specific private end point connection by specific private link service in the resource group.
function getPrivateEndpointConnection(resourceGroupName: string, serviceName: string, peConnectionName: string, options?: PrivateLinkServicesGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
- peConnectionName
-
string
The name of the private end point connection.
The options parameters.
Returns
Promise<PrivateEndpointConnection>
list(string, PrivateLinkServicesListOptionalParams)
Gets all private link services in a resource group.
function list(resourceGroupName: string, options?: PrivateLinkServicesListOptionalParams): PagedAsyncIterableIterator<PrivateLinkService, PrivateLinkService[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listAutoApprovedPrivateLinkServices(string, PrivateLinkServicesListAutoApprovedPrivateLinkServicesOptionalParams)
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.
function listAutoApprovedPrivateLinkServices(location: string, options?: PrivateLinkServicesListAutoApprovedPrivateLinkServicesOptionalParams): PagedAsyncIterableIterator<AutoApprovedPrivateLinkService, AutoApprovedPrivateLinkService[], PageSettings>Parameters
- location
-
string
The location of the domain name.
The options parameters.
Returns
listAutoApprovedPrivateLinkServicesByResourceGroup(string, string, PrivateLinkServicesListAutoApprovedPrivateLinkServicesByResourceGroupOptionalParams)
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.
function listAutoApprovedPrivateLinkServicesByResourceGroup(location: string, resourceGroupName: string, options?: PrivateLinkServicesListAutoApprovedPrivateLinkServicesByResourceGroupOptionalParams): PagedAsyncIterableIterator<AutoApprovedPrivateLinkService, AutoApprovedPrivateLinkService[], PageSettings>Parameters
- location
-
string
The location of the domain name.
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listBySubscription(PrivateLinkServicesListBySubscriptionOptionalParams)
Gets all private link service in a subscription.
function listBySubscription(options?: PrivateLinkServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PrivateLinkService, PrivateLinkService[], PageSettings>Parameters
The options parameters.
Returns
listPrivateEndpointConnections(string, string, PrivateLinkServicesListPrivateEndpointConnectionsOptionalParams)
Gets all private end point connections for a specific private link service.
function listPrivateEndpointConnections(resourceGroupName: string, serviceName: string, options?: PrivateLinkServicesListPrivateEndpointConnectionsOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
The options parameters.
Returns
updatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, PrivateLinkServicesUpdatePrivateEndpointConnectionOptionalParams)
Approve or reject private end point connection for a private link service in a subscription.
function updatePrivateEndpointConnection(resourceGroupName: string, serviceName: string, peConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateLinkServicesUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group.
- serviceName
-
string
The name of the private link service.
- peConnectionName
-
string
The name of the private end point connection.
- parameters
- PrivateEndpointConnection
Parameters supplied to approve or reject the private end point connection.
The options parameters.
Returns
Promise<PrivateEndpointConnection>