PrivateLinksOperations interface

Package:

@azure/arm-security

Interface representing a PrivateLinks operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
create	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.
delete	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.
get	Get a private link resource. Returns the configuration and status of private endpoint connectivity for Microsoft Defender for Cloud services in the specified region.
head	Checks whether private link exists.
list	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.
listBySubscription	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.
update	Update specific properties of a private link resource. Use this operation to update mutable properties like tags without affecting the entire resource configuration.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, privateLinkName: string, privateLink: PrivateLinkResource, options?: PrivateLinksCreateOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateLinkResource>, PrivateLinkResource>>

Property Value

(resourceGroupName: string, privateLinkName: string, privateLink: PrivateLinkResource, options?: PrivateLinksCreateOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateLinkResource>, PrivateLinkResource>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, privateLinkName: string, privateLink: PrivateLinkResource, options?: PrivateLinksCreateOptionalParams) => Promise<PrivateLinkResource>

Property Value

(resourceGroupName: string, privateLinkName: string, privateLink: PrivateLinkResource, options?: PrivateLinksCreateOptionalParams) => Promise<PrivateLinkResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, privateLinkName: string, options?: PrivateLinksDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, privateLinkName: string, options?: PrivateLinksDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, privateLinkName: string, options?: PrivateLinksDeleteOptionalParams) => Promise<void>

create

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.

create: (resourceGroupName: string, privateLinkName: string, privateLink: PrivateLinkResource, options?: PrivateLinksCreateOptionalParams) => PollerLike<OperationState<PrivateLinkResource>, PrivateLinkResource>

Property Value

(resourceGroupName: string, privateLinkName: string, privateLink: PrivateLinkResource, options?: PrivateLinksCreateOptionalParams) => PollerLike<OperationState<PrivateLinkResource>, PrivateLinkResource>

delete

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.

delete: (resourceGroupName: string, privateLinkName: string, options?: PrivateLinksDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, privateLinkName: string, options?: PrivateLinksDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

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

get: (resourceGroupName: string, privateLinkName: string, options?: PrivateLinksGetOptionalParams) => Promise<PrivateLinkResource>

Property Value

(resourceGroupName: string, privateLinkName: string, options?: PrivateLinksGetOptionalParams) => Promise<PrivateLinkResource>

head

Checks whether private link exists.

head: (resourceGroupName: string, privateLinkName: string, options?: PrivateLinksHeadOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, privateLinkName: string, options?: PrivateLinksHeadOptionalParams) => Promise<void>

list

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.

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

Property Value

(resourceGroupName: string, options?: PrivateLinksListOptionalParams) => PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>

listBySubscription

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.

listBySubscription: (options?: PrivateLinksListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>

Property Value

(options?: PrivateLinksListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>

update

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

update: (resourceGroupName: string, privateLinkName: string, privateLink: PrivateLinkUpdate, options?: PrivateLinksUpdateOptionalParams) => Promise<PrivateLinkResource>

Property Value

(resourceGroupName: string, privateLinkName: string, privateLink: PrivateLinkUpdate, options?: PrivateLinksUpdateOptionalParams) => Promise<PrivateLinkResource>