Share via

Private Endpoint Connections - Create Or Update

Service:
Service Bus
API Version:
2024-01-01

Creates or updates PrivateEndpointConnections of service namespace.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-01-01

URI Parameters

Name In Required Type Description
namespaceName
 path True

string

minLength: 6
maxLength: 50

The namespace name
privateEndpointConnectionName
 path True

string

The PrivateEndpointConnection name
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
properties.privateEndpoint

PrivateEndpoint

The Private Endpoint resource for this Connection.
properties.privateLinkServiceConnectionState

ConnectionState

Details about the state of the connection.
properties.provisioningState

EndPointProvisioningState

Provisioning state of the Private Endpoint Connection.

Responses

Name Type Description
200 OK

PrivateEndpointConnection

Status of PrivateEndPoint Connection Created successfully.
201 Created

PrivateEndpointConnection

Request to update Status of PrivateEndPoint Connection accepted.
202 Accepted

PrivateEndpointConnection

Request to update Status of PrivateEndPoint Connection accepted.
Other Status Codes

ErrorResponse

ServiceBus 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

NameSpacePrivateEndPointConnectionCreate

Sample request

PUT https://management.azure.com/subscriptions/subID/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-01-01

{
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "testing"
    },
    "provisioningState": "Succeeded"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}
Status code:
201 
{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}
Status code:
202 
{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Definitions

Name Description
ConnectionState

ConnectionState information.
createdByType

The type of identity that created the resource.
EndPointProvisioningState

Provisioning state of the Private Endpoint Connection.
Error

The error object.
ErrorAdditionalInfo

The resource management error additional info.
ErrorResponse

The resource management error response.
PrivateEndpoint

PrivateEndpoint information.
PrivateEndpointConnection

Properties of the PrivateEndpointConnection.
PrivateLinkConnectionStatus

Status of the connection.
systemData

Metadata pertaining to creation and last modification of the resource.

ConnectionState

Object

ConnectionState information.

Name Type Description
description

string

Description of the connection state.
status

PrivateLinkConnectionStatus

Status of the connection.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

EndPointProvisioningState

Enumeration

Provisioning state of the Private Endpoint Connection.

Value Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

Error

Object

The error object.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorResponse[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorResponse

Object

The resource management error response.

Name Type Description
error

Error

The error object.

PrivateEndpoint

Object

PrivateEndpoint information.

Name Type Description
id

string

The ARM identifier for Private Endpoint.

PrivateEndpointConnection

Object

Properties of the PrivateEndpointConnection.

Name Type Description
id

string

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

string

The geo-location where the resource lives
name

string

The name of the resource
properties.privateEndpoint

PrivateEndpoint

The Private Endpoint resource for this Connection.
properties.privateLinkServiceConnectionState

ConnectionState

Details about the state of the connection.
properties.provisioningState

EndPointProvisioningState

Provisioning state of the Private Endpoint Connection.
systemData

systemData

The system meta data relating to this resource.
type

string

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Enumeration

Status of the connection.

Value Description
Pending
Approved
Rejected
Disconnected

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 type of identity that last modified the resource.
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.