PrivateLinksClient Interface

public interface PrivateLinksClient

An instance of this class provides access to all the operations defined in PrivateLinksClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<PrivateLinkResourceInner>,PrivateLinkResourceInner> beginCreate(String resourceGroupName, String privateLinkName, PrivateLinkResourceInner privateLink)

Create a private link resource.

abstract SyncPoller<PollResult<PrivateLinkResourceInner>,PrivateLinkResourceInner> beginCreate(String resourceGroupName, String privateLinkName, PrivateLinkResourceInner privateLink, Context context)

Create a private link resource.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String privateLinkName)

Delete a private link resource.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String privateLinkName, Context context)

Delete a private link resource.

abstract PrivateLinkResourceInner create(String resourceGroupName, String privateLinkName, PrivateLinkResourceInner privateLink)

Create a private link resource.

abstract PrivateLinkResourceInner create(String resourceGroupName, String privateLinkName, PrivateLinkResourceInner privateLink, Context context)

Create a private link resource.

abstract void delete(String resourceGroupName, String privateLinkName)

Delete a private link resource.

abstract void delete(String resourceGroupName, String privateLinkName, Context context)

Delete a private link resource.

abstract PrivateLinkResourceInner getByResourceGroup(String resourceGroupName, String privateLinkName)

Get a private link resource.

abstract Response<PrivateLinkResourceInner> getByResourceGroupWithResponse(String resourceGroupName, String privateLinkName, Context context)

Get a private link resource.

abstract void head(String resourceGroupName, String privateLinkName)

Checks whether private link exists.

abstract Response<Void> headWithResponse(String resourceGroupName, String privateLinkName, Context context)

Checks whether private link exists.

abstract PagedIterable<PrivateLinkResourceInner> list()

Lists all the private links in the specified subscription.

abstract PagedIterable<PrivateLinkResourceInner> list(Context context)

Lists all the private links in the specified subscription.

abstract PagedIterable<PrivateLinkResourceInner> listByResourceGroup(String resourceGroupName)

Lists all the private links in the specified resource group.

abstract PagedIterable<PrivateLinkResourceInner> listByResourceGroup(String resourceGroupName, Context context)

Lists all the private links in the specified resource group.

abstract PrivateLinkResourceInner update(String resourceGroupName, String privateLinkName, PrivateLinkUpdate privateLink)

Update specific properties of a private link resource.

abstract Response<PrivateLinkResourceInner> updateWithResponse(String resourceGroupName, String privateLinkName, PrivateLinkUpdate privateLink, Context context)

Update specific properties of a private link resource.

Method Details

beginCreate

public abstract SyncPoller<PollResult<PrivateLinkResourceInner>,PrivateLinkResourceInner> beginCreate(String resourceGroupName, String privateLinkName, PrivateLinkResourceInner privateLink)

Create a private link resource. This operation creates the necessary infrastructure to enable private endpoint connections to Microsoft Defender for Cloud services. For updates to existing resources, use the PATCH operation. The operation is asynchronous and may take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateLink - Private link request payload containing the resource information for create operations.

Returns:

the SyncPoller<T,U> for polling of a private link resource that enables secure, private connectivity to Microsoft Defender for Cloud services.

beginCreate

public abstract SyncPoller<PollResult<PrivateLinkResourceInner>,PrivateLinkResourceInner> beginCreate(String resourceGroupName, String privateLinkName, PrivateLinkResourceInner privateLink, Context context)

Create a private link resource. This operation creates the necessary infrastructure to enable private endpoint connections to Microsoft Defender for Cloud services. For updates to existing resources, use the PATCH operation. The operation is asynchronous and may take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateLink - Private link request payload containing the resource information for create operations.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of a private link resource that enables secure, private connectivity to Microsoft Defender for Cloud services.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String privateLinkName)

Delete a private link resource. This operation will remove the private link infrastructure and disconnect all associated private endpoints. This operation is asynchronous and may take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String privateLinkName, Context context)

Delete a private link resource. This operation will remove the private link infrastructure and disconnect all associated private endpoints. This operation is asynchronous and may take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

create

public abstract PrivateLinkResourceInner create(String resourceGroupName, String privateLinkName, PrivateLinkResourceInner privateLink)

Create a private link resource. This operation creates the necessary infrastructure to enable private endpoint connections to Microsoft Defender for Cloud services. For updates to existing resources, use the PATCH operation. The operation is asynchronous and may take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateLink - Private link request payload containing the resource information for create operations.

Returns:

a private link resource that enables secure, private connectivity to Microsoft Defender for Cloud services.

create

public abstract PrivateLinkResourceInner create(String resourceGroupName, String privateLinkName, PrivateLinkResourceInner privateLink, Context context)

Create a private link resource. This operation creates the necessary infrastructure to enable private endpoint connections to Microsoft Defender for Cloud services. For updates to existing resources, use the PATCH operation. The operation is asynchronous and may take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateLink - Private link request payload containing the resource information for create operations.
context - The context to associate with this operation.

Returns:

a private link resource that enables secure, private connectivity to Microsoft Defender for Cloud services.

delete

public abstract void delete(String resourceGroupName, String privateLinkName)

Delete a private link resource. This operation will remove the private link infrastructure and disconnect all associated private endpoints. This operation is asynchronous and may take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.

delete

public abstract void delete(String resourceGroupName, String privateLinkName, Context context)

Delete a private link resource. This operation will remove the private link infrastructure and disconnect all associated private endpoints. This operation is asynchronous and may take several minutes to complete.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
context - The context to associate with this operation.

getByResourceGroup

public abstract PrivateLinkResourceInner getByResourceGroup(String resourceGroupName, String privateLinkName)

Get a private link resource. Returns the configuration and status of private endpoint connectivity for Microsoft Defender for Cloud services in the specified region.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.

Returns:

a private link resource.

getByResourceGroupWithResponse

public abstract Response<PrivateLinkResourceInner> getByResourceGroupWithResponse(String resourceGroupName, String privateLinkName, Context context)

Get a private link resource. Returns the configuration and status of private endpoint connectivity for Microsoft Defender for Cloud services in the specified region.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
context - The context to associate with this operation.

Returns:

a private link resource along with Response<T>.

head

public abstract void head(String resourceGroupName, String privateLinkName)

Checks whether private link exists.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.

headWithResponse

public abstract Response<Void> headWithResponse(String resourceGroupName, String privateLinkName, Context context)

Checks whether private link exists.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
context - The context to associate with this operation.

Returns:

list

public abstract PagedIterable<PrivateLinkResourceInner> list()

Lists all the private links in the specified subscription. private links enable secure, private connectivity to Microsoft Defender for Cloud services without exposing traffic to the public internet. Use the 'nextLink' property in the response to get the next page of private links for the specified subscription.

Returns:

paginated list of private link resources as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<PrivateLinkResourceInner> list(Context context)

Lists all the private links in the specified subscription. private links enable secure, private connectivity to Microsoft Defender for Cloud services without exposing traffic to the public internet. Use the 'nextLink' property in the response to get the next page of private links for the specified subscription.

Parameters:

context - The context to associate with this operation.

Returns:

paginated list of private link resources as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<PrivateLinkResourceInner> listByResourceGroup(String resourceGroupName)

Lists all the private links in the specified resource group. private links enable secure, private connectivity to Microsoft Defender for Cloud services without exposing traffic to the public internet. Use the 'nextLink' property in the response to get the next page of private links for the specified resource group.

Parameters:

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

Returns:

paginated list of private link resources as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<PrivateLinkResourceInner> listByResourceGroup(String resourceGroupName, Context context)

Lists all the private links in the specified resource group. private links enable secure, private connectivity to Microsoft Defender for Cloud services without exposing traffic to the public internet. Use the 'nextLink' property in the response to get the next page of private links for the specified resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
context - The context to associate with this operation.

Returns:

paginated list of private link resources as paginated response with PagedIterable<T>.

update

public abstract PrivateLinkResourceInner update(String resourceGroupName, String privateLinkName, PrivateLinkUpdate privateLink)

Update specific properties of a private link resource. Use this operation to update mutable properties like tags without affecting the entire resource configuration.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateLink - private link update payload containing only the properties to be updated.

Returns:

a private link resource that enables secure, private connectivity to Microsoft Defender for Cloud services.

updateWithResponse

public abstract Response<PrivateLinkResourceInner> updateWithResponse(String resourceGroupName, String privateLinkName, PrivateLinkUpdate privateLink, Context context)

Update specific properties of a private link resource. Use this operation to update mutable properties like tags without affecting the entire resource configuration.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
privateLinkName - The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.
privateLink - private link update payload containing only the properties to be updated.
context - The context to associate with this operation.

Returns:

a private link resource that enables secure, private connectivity to Microsoft Defender for Cloud services along with Response<T>.

Applies to