Private Link Scopes - Create Or Update

Service:: Hybrid Compute

API Version:: 2025-01-13

Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}?api-version=2025-01-13

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
scopeName	path	True	string pattern: [a-zA-Z0-9-_\.]+	The name of the Azure Arc PrivateLinkScope resource.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	Resource location
properties		HybridComputePrivateLinkScopeProperties	Properties that define a Azure Arc PrivateLinkScope resource.
tags		object	Resource tags

Responses

Name	Type	Description
200 OK	HybridComputePrivateLinkScope	Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope is returned.
201 Created	HybridComputePrivateLinkScope	Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope was created and is returned.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

PrivateLinkScopeCreate

PrivateLinkScopeUpdate

PrivateLinkScopeCreate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/Microsoft.HybridCompute/privateLinkScopes/my-privatelinkscope?api-version=2025-01-13

{
  "location": "westus"
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope",
  "name": "my-privatelinkscope",
  "type": "Microsoft.HybridCompute/privateLinkScopes",
  "location": "westus",
  "tags": {},
  "properties": {
    "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name",
        "name": "private-endpoint-connection-name",
        "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Status code:: 201

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope",
  "name": "my-privatelinkscope",
  "type": "Microsoft.HybridCompute/privateLinkScopes",
  "location": "westus",
  "tags": {},
  "properties": {
    "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name",
        "name": "private-endpoint-connection-name",
        "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

PrivateLinkScopeUpdate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/Microsoft.HybridCompute/privateLinkScopes/my-privatelinkscope?api-version=2025-01-13

{
  "location": "westus",
  "tags": {
    "Tag1": "Value1"
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope",
  "name": "my-privatelinkscope",
  "type": "Microsoft.HybridCompute/privateLinkScopes",
  "location": "westus",
  "tags": {
    "Tag1": "Value1"
  },
  "properties": {
    "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name",
        "name": "private-endpoint-connection-name",
        "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Status code:: 201

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope",
  "name": "my-privatelinkscope",
  "type": "Microsoft.HybridCompute/privateLinkScopes",
  "location": "westus",
  "tags": {
    "Tag1": "Value1"
  },
  "properties": {
    "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name",
        "name": "private-endpoint-connection-name",
        "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HybridComputePrivateLinkScope	An Azure Arc PrivateLinkScope definition.
HybridComputePrivateLinkScopeProperties	Properties that define a Azure Arc PrivateLinkScope resource.
PrivateEndpointConnectionDataModel	The Data Model for a Private Endpoint Connection associated with a Private Link Scope
PrivateEndpointConnectionProperties	Properties of a private endpoint connection.
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionStateProperty	State of the private endpoint connection.
PublicNetworkAccessType	The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HybridComputePrivateLinkScope

Object

An Azure Arc PrivateLinkScope definition.

Name	Type	Description
id	string	Azure resource Id
location	string	Resource location
name	string	Azure resource name
properties	HybridComputePrivateLinkScopeProperties	Properties that define a Azure Arc PrivateLinkScope resource.
systemData	systemData	The system meta data relating to this resource.
tags	object	Resource tags
type	string	Azure resource type

HybridComputePrivateLinkScopeProperties

Object

Properties that define a Azure Arc PrivateLinkScope resource.

Name	Type	Default value	Description
privateEndpointConnections	PrivateEndpointConnectionDataModel[]		The collection of associated Private Endpoint Connections.
privateLinkScopeId	string		The Guid id of the private link scope.
provisioningState	string		Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.
publicNetworkAccess	PublicNetworkAccessType	Disabled	Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.

PrivateEndpointConnectionDataModel

Object

The Data Model for a Private Endpoint Connection associated with a Private Link Scope

Name	Type	Description
id	string	The ARM Resource Id of the Private Endpoint.
name	string	The Name of the Private Endpoint.
properties	PrivateEndpointConnectionProperties	The Private Endpoint Connection properties.
type	string	Azure resource type

PrivateEndpointConnectionProperties

Object

Properties of a private endpoint connection.

Name	Type	Description
groupIds	string[]	List of group IDs.
privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Connection state of the private endpoint connection.
provisioningState	string	State of the private endpoint connection.

PrivateEndpointProperty

Object

Private endpoint which the connection belongs to.

Name	Type	Description
id	string	Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

Object

State of the private endpoint connection.

Name	Type	Description
actionsRequired	string	The actions required for private link service connection.
description	string	The private link service connection description.
status	string	The private link service connection status.

PublicNetworkAccessType

Enumeration

The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).

Value	Description
Enabled	Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints.
Disabled	Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Private Link Scopes - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

PrivateLinkScopeCreate

Sample request

Sample response

PrivateLinkScopeUpdate

Sample request

Sample response

Definitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HybridComputePrivateLinkScope

HybridComputePrivateLinkScopeProperties

PrivateEndpointConnectionDataModel

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccessType

systemData