Private Link Resources - Get

Get the specified private link resource for the given IotHub

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}?api-version=2023-06-30

URI Parameters

Name In Required Type Description
groupId
path True

string

The name of the private link resource

resourceGroupName
path True

string

The name of the resource group that contains the IoT hub.

resourceName
path True

string

The name of the IoT hub.

subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

The version of the API.

Responses

Name Type Description
200 OK

GroupIdInformation

The body contains the specified of private link resource

Other Status Codes

ErrorDetails

DefaultErrorResponse

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

PrivateLinkResources_List

Sample request

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/iotHubs/testHub/privateLinkResources/iotHub?api-version=2023-06-30

Sample response

{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub",
  "name": "iotHub",
  "type": "Microsoft.Devices/IotHubs/PrivateLinkResources",
  "properties": {
    "groupId": "iotHub",
    "requiredMembers": [
      "iotHub"
    ],
    "requiredZoneNames": [
      "privatelink.azure-devices.net"
    ]
  }
}

Definitions

Name Description
ErrorDetails

Error details.

GroupIdInformation

The group information for creating a private endpoint on an IotHub

GroupIdInformationProperties

The properties for a group information object

ErrorDetails

Error details.

Name Type Description
code

string

The error code.

details

string

The error details.

httpStatusCode

string

The HTTP status code.

message

string

The error message.

GroupIdInformation

The group information for creating a private endpoint on an IotHub

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties

GroupIdInformationProperties

The properties for a group information object

type

string

The resource type.

GroupIdInformationProperties

The properties for a group information object

Name Type Description
groupId

string

The group id

requiredMembers

string[]

The required members for a specific group id

requiredZoneNames

string[]

The required DNS zones for a specific group id