Private Endpoint Connections - Update
Aktualisieren der Verbindung mit privaten Endpunkten
Aktualisieren der status einer Privaten Endpunktverbindung mit dem angegebenen Namen
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-06-30
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
private
|
path | True |
string |
Der Name der Verbindung mit dem privaten Endpunkt |
resource
|
path | True |
string |
Der Name der Ressourcengruppe, die den IoT Hub enthält. |
resource
|
path | True |
string |
Der Name des IoT-Hubs. |
subscription
|
path | True |
string |
Die Abonnement-ID. |
api-version
|
query | True |
string |
Die Version der API. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
properties | True |
Die Eigenschaften einer Verbindung mit einem privaten Endpunkt |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Dies wird als Antwort auf die status Abrufanforderung für den Aktualisierungsvorgang zurückgegeben. |
|
201 Created |
Dieser Vorgang dauert lange. Der Vorgang gibt einen Wert vom Typ 201 zurück, wenn die Überprüfung abgeschlossen ist. Die Antwort enthält einen Azure-AsyncOperation-Header, der eine status-URL enthält. Von Clients wird erwartet, dass sie die status-URL für die status des Vorgangs abfragen. Bei erfolgreicher Ausführung gibt der Vorgang HTTP-status Code von 201 (OK) zurück. |
|
Other Status Codes |
DefaultErrorResponse |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
PrivateEndpointConnection_Update
Beispielanforderung
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/iotHubs/testHub/privateEndpointConnections/myPrivateEndpointConnection?api-version=2023-06-30
{
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by johndoe@contoso.com"
}
}
}
Beispiel für eine Antwort
{
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection",
"name": "myPrivateEndpointConnection",
"type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by johndoe@contoso.com",
"actionsRequired": "None"
}
}
}
{
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection",
"name": "myPrivateEndpointConnection",
"type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by johndoe@contoso.com",
"actionsRequired": "None"
}
}
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerdetails. |
Private |
Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt |
Private |
Die Private Endpunktverbindung einer IotHub-Instanz |
Private |
Die Eigenschaften einer Verbindung mit einem privaten Endpunkt |
Private |
Der aktuelle Status einer Verbindung mit einem privaten Endpunkt |
Private |
Die status einer Verbindung mit einem privaten Endpunkt |
ErrorDetails
Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
details |
string |
Die Fehlerdetails. |
httpStatusCode |
string |
Der HTTP-Statuscode. |
message |
string |
Die Fehlermeldung. |
PrivateEndpoint
Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Der Ressourcenbezeichner. |
PrivateEndpointConnection
Die Private Endpunktverbindung einer IotHub-Instanz
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Der Ressourcenbezeichner. |
name |
string |
Der Name der Ressource. |
properties |
Die Eigenschaften einer Verbindung mit einem privaten Endpunkt |
|
type |
string |
Der Ressourcentyp. |
PrivateEndpointConnectionProperties
Die Eigenschaften einer Verbindung mit einem privaten Endpunkt
Name | Typ | Beschreibung |
---|---|---|
privateEndpoint |
Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt |
|
privateLinkServiceConnectionState |
Der aktuelle Status einer Verbindung mit einem privaten Endpunkt |
PrivateLinkServiceConnectionState
Der aktuelle Status einer Verbindung mit einem privaten Endpunkt
Name | Typ | Beschreibung |
---|---|---|
actionsRequired |
string |
Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen |
description |
string |
Die Beschreibung für den aktuellen Status einer Verbindung mit einem privaten Endpunkt |
status |
Die status einer Verbindung mit einem privaten Endpunkt |
PrivateLinkServiceConnectionStatus
Die status einer Verbindung mit einem privaten Endpunkt
Name | Typ | Beschreibung |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |