PrivateLinkResource interface

Package:
@azure/arm-security

A private link resource that enables secure, private connectivity to Microsoft Defender for Cloud services. This resource manages the lifecycle of private endpoint connections and provides the necessary infrastructure for private connectivity.

Extends
TrackedResource

Properties

privateEndpointConnections

List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.
privateLinkResources

List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.
provisioningState

The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.
publicNetworkAccess

This determines if traffic is allowed over public network. By default it is disabled.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

privateEndpointConnections

List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

privateLinkResources

List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.

privateLinkResources?: PrivateLinkGroupResource[]

Property Value

PrivateLinkGroupResource[]

provisioningState

The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.

provisioningState?: string

Property Value

string

publicNetworkAccess

This determines if traffic is allowed over public network. By default it is disabled.

publicNetworkAccess?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type