Iot Dps Resource - Get Private Link Resources

Reference

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Get the specified private link resource for the given provisioning service

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources/{groupId}?api-version=2022-12-12

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 provisioning service.
resourceName	path	True	string	The name of the provisioning service.
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

HTTP

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/privateLinkResources/iotDps?api-version=2022-12-12

Sample response

Status code:: 200

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

Definitions

Name	Description
ErrorDetails	Error details.
GroupIdInformation	The group information for creating a private endpoint on a provisioning service
GroupIdInformationProperties	The properties for a group information object

ErrorDetails

Error details.

Name	Type	Description
code	integer	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 a provisioning service

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

Share via