{ "swagger": "2.0", "info": { "title": "Microsoft Defender for Cloud - private links", "version": "2026-01-01", "description": "API specification for Microsoft.Security (Microsoft Defender for Cloud) private links resource provider. This API enables customers to create and manage private endpoint connections to Defender for Cloud services, providing secure connectivity without exposing traffic to the public internet. private links support private connectivity to Defender APIs and regional data endpoints.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "PrivateLinks" }, { "name": "PrivateLinkResources" }, { "name": "PrivateEndpointConnections" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Security/privateLinks": { "get": { "operationId": "PrivateLinks_ListBySubscription", "tags": [ "PrivateLinks" ], "description": "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": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinksList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List private links by subscription": { "$ref": "./examples/PrivateLinks/PrivateLinks_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/privateLinks": { "get": { "operationId": "PrivateLinks_List", "tags": [ "PrivateLinks" ], "description": "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": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinksList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List private links": { "$ref": "./examples/PrivateLinks/PrivateLinks_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/privateLinks/{privateLinkName}": { "get": { "operationId": "PrivateLinks_Get", "tags": [ "PrivateLinks" ], "description": "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": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get private link": { "$ref": "./examples/PrivateLinks/PrivateLinks_Get.json" } } }, "put": { "operationId": "PrivateLinks_Create", "tags": [ "PrivateLinks" ], "description": "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": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "privateLink", "in": "body", "description": "Private link request payload containing the resource information for create operations.", "required": true, "schema": { "$ref": "#/definitions/PrivateLinkResource" } } ], "responses": { "200": { "description": "Resource 'PrivateLinkResource' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateLinkResource" } }, "201": { "description": "Resource 'PrivateLinkResource' create operation succeeded", "schema": { "$ref": "#/definitions/PrivateLinkResource" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create private link": { "$ref": "./examples/PrivateLinks/PrivateLinks_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/PrivateLinkResource" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "PrivateLinks_Update", "tags": [ "PrivateLinks" ], "description": "Update specific properties of a private link resource. Use this operation to update mutable properties like tags without affecting the entire resource configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "privateLink", "in": "body", "description": "private link update payload containing only the properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/PrivateLinkUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update private link": { "$ref": "./examples/PrivateLinks/PrivateLinks_Update.json" } } }, "delete": { "operationId": "PrivateLinks_Delete", "tags": [ "PrivateLinks" ], "description": "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": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete private link": { "$ref": "./examples/PrivateLinks/PrivateLinks_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "head": { "operationId": "PrivateLinks_Head", "description": "Checks whether private link exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Checks whether private link exists": { "$ref": "./examples/PrivateLinks/PrivateLinks_Head.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/privateLinks/{privateLinkName}/privateEndpointConnections": { "get": { "operationId": "PrivateEndpointConnections_List", "tags": [ "PrivateEndpointConnections" ], "description": "Gets all private endpoint connections for a private link. Returns the list of private endpoints that are connected or in the process of connecting to this private link.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List private endpoint connections": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnections_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/privateLinks/{privateLinkName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnections_Get", "tags": [ "PrivateEndpointConnections" ], "description": "Gets the specified private endpoint connection associated with the private link. Returns the connection details, status, and configuration for a specific private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get private endpoint connection": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnections_Get.json" } } }, "put": { "operationId": "PrivateEndpointConnections_CreateOrUpdate", "tags": [ "PrivateEndpointConnections" ], "description": "Update the state of specified private endpoint connection associated with the private link. This operation is typically used to approve or reject pending private endpoint connections.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "name": "privateEndpointConnection", "in": "body", "description": "The private endpoint connection resource.", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Resource 'PrivateEndpointConnection' create operation succeeded", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update private endpoint connection": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnections_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "PrivateEndpointConnections_Delete", "tags": [ "PrivateEndpointConnections" ], "description": "Deletes the specified private endpoint connection associated with the private link. This operation will disconnect the private endpoint and remove the connection configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete private endpoint connection": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnections_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/privateLinks/{privateLinkName}/privateLinkResources": { "get": { "operationId": "PrivateLinkResources_List", "tags": [ "PrivateLinkResources" ], "description": "List all private link resources in a private link.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkGroupResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List private link resources": { "$ref": "./examples/PrivateLinkResources/PrivateLinkResources_ListByPrivateLink.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/privateLinks/{privateLinkName}/privateLinkResources/{groupId}": { "get": { "operationId": "PrivateLinkResources_Get", "tags": [ "PrivateLinkResources" ], "description": "Get the specified private link resource associated with the private link.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateLinkName", "in": "path", "description": "The name of the private link resource. Must be unique within the resource group and follow Azure naming conventions.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" }, { "name": "groupId", "in": "path", "description": "The group ID of the private link resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkGroupResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get private link resource": { "$ref": "./examples/PrivateLinkResources/PrivateLinkResources_Get.json" } } } } }, "definitions": { "Common.ProvisioningState": { "type": "string", "description": "The current provisioning state of the resource. Indicates the status of the last operation performed on the resource.", "enum": [ "Succeeded", "Creating", "Updating", "Deleting", "Failed", "Canceled", "InProgress" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "The resource has been successfully provisioned and is ready for use." }, { "name": "Creating", "value": "Creating", "description": "The resource is being created. This is a transitional state." }, { "name": "Updating", "value": "Updating", "description": "The resource is being updated. This is a transitional state." }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted. This is a transitional state." }, { "name": "Failed", "value": "Failed", "description": "The last operation on the resource failed. Check the error details for more information." }, { "name": "Canceled", "value": "Canceled", "description": "The operation was canceled before completion." }, { "name": "InProgress", "value": "InProgress", "description": "InProgress" } ] } }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "The response of a PrivateEndpointConnection list operation.", "properties": { "value": { "type": "array", "description": "The PrivateEndpointConnection items on this page", "items": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateLinkGroupResource": { "type": "object", "description": "A private link group resource that describes a grouping for the private link.", "properties": { "properties": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PrivateLinkGroupResourceListResult": { "type": "object", "description": "The response of a PrivateLinkGroupResource list operation.", "properties": { "value": { "type": "array", "description": "The PrivateLinkGroupResource items on this page", "items": { "$ref": "#/definitions/PrivateLinkGroupResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateLinkProperties": { "type": "object", "description": "Properties of a private link resource. These properties control the behavior and configuration of private endpoint connectivity to Defender services.", "properties": { "provisioningState": { "$ref": "#/definitions/Common.ProvisioningState", "description": "The current provisioning state of the private link resource. Indicates whether the resource is being created, updated, deleted, or has completed successfully.", "readOnly": true }, "privateEndpointConnections": { "type": "array", "description": "List of private endpoint connections associated with this private link. Each connection represents a private endpoint from a customer's virtual network.", "items": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, "readOnly": true }, "privateLinkResources": { "type": "array", "description": "List of private link resources available for connection. For Defender services, this typically includes the 'containers' group with 'api' and regional data endpoints.", "items": { "$ref": "#/definitions/PrivateLinkGroupResource" }, "readOnly": true }, "publicNetworkAccess": { "type": "string", "description": "This determines if traffic is allowed over public network. By default it is disabled.", "default": "Disabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" } ] } } } }, "PrivateLinkResource": { "type": "object", "description": "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.", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkProperties", "description": "Properties specific to the private link resource", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "PrivateLinkUpdate": { "type": "object", "description": "Request payload for updating a private link resource. Used in PATCH operations to update specific mutable properties without affecting the entire resource configuration.", "properties": { "tags": { "type": "object", "description": "Resource tags", "additionalProperties": { "type": "string" } } } }, "PrivateLinksList": { "type": "object", "description": "Paginated list of private link resources. Contains an array of private links and optional pagination information.", "properties": { "value": { "type": "array", "description": "The PrivateLinkResource items on this page", "items": { "$ref": "#/definitions/PrivateLinkResource" }, "readOnly": true }, "nextLink": { "type": "string", "description": "The link to the next page of items" } }, "required": [ "value" ] } }, "parameters": {} }