Freigeben über


Private Link Resources - List

Auflisten von Private Link-Ressourcen für den angegebenen IotHub

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe, die den IoT Hub enthält.

resourceName
path True

string

Der Name des IoT-Hubs.

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die Version der API.

Antworten

Name Typ Beschreibung
200 OK

PrivateLinkResources

Der Text enthält die Liste der Private Link-Ressourcen.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

PrivateLinkResources_List

Sample Request

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

Sample Response

{
  "value": [
    {
      "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"
        ]
      }
    }
  ]
}

Definitionen

Name Beschreibung
ErrorDetails

Fehlerdetails.

GroupIdInformation

Die Gruppeninformationen zum Erstellen eines privaten Endpunkts auf einem IotHub

GroupIdInformationProperties

Die Eigenschaften für ein Gruppeninformationsobjekt

PrivateLinkResources

Die verfügbaren Private Link-Ressourcen für iotHub

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

GroupIdInformation

Die Gruppeninformationen zum Erstellen eines privaten Endpunkts auf einem IotHub

Name Typ Beschreibung
id

string

Der Ressourcenbezeichner.

name

string

Der Name der Ressource.

properties

GroupIdInformationProperties

Die Eigenschaften für ein Gruppeninformationsobjekt

type

string

Der Ressourcentyp.

GroupIdInformationProperties

Die Eigenschaften für ein Gruppeninformationsobjekt

Name Typ Beschreibung
groupId

string

Die Gruppen-ID

requiredMembers

string[]

Die erforderlichen Mitglieder für eine bestimmte Gruppen-ID

requiredZoneNames

string[]

Die erforderlichen DNS-Zonen für eine bestimmte Gruppen-ID

PrivateLinkResources

Die verfügbaren Private Link-Ressourcen für iotHub

Name Typ Beschreibung
value

GroupIdInformation[]

Die Liste der verfügbaren Private Link-Ressourcen für einen IotHub