Private Endpoint Connections - List

Service:

Service Bus

API Version:

2024-01-01

Gets the available PrivateEndpointConnections within a namespace.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	The namespace 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.

Responses

Name	Type	Description
200 OK	PrivateEndpointConnectionListResult	PrivateEndpointConnections successfully returned.
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

NameSpaceCreate

Sample request

HTTP

GET https://management.azure.com/subscriptions/subID/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections?api-version=2024-01-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/NameSpaces/PrivateEndPointConnectionList.json
// this example is just showing the usage of "PrivateEndpointConnections_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceBusNamespaceResource created on azure
// for more information of creating ServiceBusNamespaceResource, please refer to the document of ServiceBusNamespaceResource
string subscriptionId = "subID";
string resourceGroupName = "SDK-ServiceBus-4794";
string namespaceName = "sdk-Namespace-5828";
ResourceIdentifier serviceBusNamespaceResourceId = ServiceBusNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
ServiceBusNamespaceResource serviceBusNamespace = client.GetServiceBusNamespaceResource(serviceBusNamespaceResourceId);

// get the collection of this ServiceBusPrivateEndpointConnectionResource
ServiceBusPrivateEndpointConnectionCollection collection = serviceBusNamespace.GetServiceBusPrivateEndpointConnections();

// invoke the operation and iterate over the result
await foreach (ServiceBusPrivateEndpointConnectionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ServiceBusPrivateEndpointConnectionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5705-new/privateEndpointConnections/5dc668b3-70e4-437f-b61c-a3c1e594be7a",
      "name": "5dc668b3-70e4-437f-b61c-a3c1e594be7a",
      "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5705-new"
        },
        "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.
PrivateEndpointConnectionListResult	Result of the list of all private endpoint connections operation.
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"

PrivateEndpointConnectionListResult

Object

Result of the list of all private endpoint connections operation.

Name	Type	Description
nextLink	string	A link for the next page of private endpoint connection resources.
value	PrivateEndpointConnection[]	A collection of private endpoint connection resources.

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.