Private Endpoint Connections - Create Or Update

Reference

Service:: Event Hubs

API Version:: 2021-06-01-preview

Creates or updates PrivateEndpointConnections of service namespace.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string	The Namespace name
privateEndpointConnectionName	path	True	string	The PrivateEndpointConnection name
resourceGroupName	path	True	string	Name of the resource group within the azure subscription.
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	Client API Version.

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.
Other Status Codes	ErrorResponse	Eventhub 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

HTTP

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

{
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-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-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-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-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Definitions

ConnectionState	ConnectionState information.
createdByType	The type of identity that created the resource.
EndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
ErrorResponse	Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.
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

ConnectionState information.

Name	Type	Description
description	string	Description of the connection state.
status	PrivateLinkConnectionStatus	Status of the connection.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Provisioning state of the Private Endpoint Connection.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorResponse

Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

PrivateEndpoint

PrivateEndpoint information.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint.

PrivateEndpointConnection

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}
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.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Status of the connection.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	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	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.