Wyświetlanie listy połączeń prywatnych punktów końcowych
Wyświetlanie listy właściwości połączenia prywatnego punktu końcowego
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections?api-version=2023-06-30
Parametry identyfikatora URI
| Nazwa |
W |
Wymagane |
Typ |
Opis |
|
resourceGroupName
|
path |
True
|
string
|
Nazwa grupy zasobów, która zawiera centrum IoT.
|
|
resourceName
|
path |
True
|
string
|
Nazwa centrum IoT.
|
|
subscriptionId
|
path |
True
|
string
|
Identyfikator subskrypcji.
|
|
api-version
|
query |
True
|
string
|
Wersja interfejsu API.
|
Odpowiedzi
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa |
Opis |
|
user_impersonation
|
personifikacja konta użytkownika
|
Przykłady
PrivateEndpointConnections_List
Przykładowe żądanie
GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/iotHubs/testHub/privateEndpointConnections?api-version=2023-06-30
/**
* Samples for PrivateEndpointConnections List.
*/
public final class Main {
/*
* x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/
* iothub_listprivateendpointconnections.json
*/
/**
* Sample code: PrivateEndpointConnections_List.
*
* @param manager Entry point to IotHubManager.
*/
public static void privateEndpointConnectionsList(com.azure.resourcemanager.iothub.IotHubManager manager) {
manager.privateEndpointConnections().listWithResponse("myResourceGroup", "testHub",
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.iothub import IotHubClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-iothub
# USAGE
python iothub_listprivateendpointconnections.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = IotHubClient(
credential=DefaultAzureCredential(),
subscription_id="91d12660-3dec-467a-be2a-213b5544ddc0",
)
response = client.private_endpoint_connections.list(
resource_group_name="myResourceGroup",
resource_name="testHub",
)
print(response)
# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listprivateendpointconnections.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armiothub_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/32c178f2467f792a322f56174be244135d2c907f/specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listprivateendpointconnections.json
func ExamplePrivateEndpointConnectionsClient_List() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().List(ctx, "myResourceGroup", "testHub", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnectionArray = []*armiothub.PrivateEndpointConnection{
// {
// Name: to.Ptr("myPrivateEndpointConnection"),
// Type: to.Ptr("Microsoft.Devices/IotHubs/PrivateEndpointConnections"),
// ID: to.Ptr("/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection"),
// Properties: &armiothub.PrivateEndpointConnectionProperties{
// PrivateEndpoint: &armiothub.PrivateEndpoint{
// ID: to.Ptr("/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
// },
// PrivateLinkServiceConnectionState: &armiothub.PrivateLinkServiceConnectionState{
// Description: to.Ptr("Please approve my request!"),
// ActionsRequired: to.Ptr("None"),
// Status: to.Ptr(armiothub.PrivateLinkServiceConnectionStatusPending),
// },
// },
// }}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { IotHubClient } = require("@azure/arm-iothub");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to List private endpoint connection properties
*
* @summary List private endpoint connection properties
* x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listprivateendpointconnections.json
*/
async function privateEndpointConnectionsList() {
const subscriptionId =
process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
const resourceName = "testHub";
const credential = new DefaultAzureCredential();
const client = new IotHubClient(credential, subscriptionId);
const result = await client.privateEndpointConnections.list(resourceGroupName, resourceName);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.IotHub.Models;
using Azure.ResourceManager.IotHub;
// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_listprivateendpointconnections.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 IotHubDescriptionResource created on azure
// for more information of creating IotHubDescriptionResource, please refer to the document of IotHubDescriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
string resourceName = "testHub";
ResourceIdentifier iotHubDescriptionResourceId = IotHubDescriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName);
IotHubDescriptionResource iotHubDescription = client.GetIotHubDescriptionResource(iotHubDescriptionResourceId);
// get the collection of this IotHubPrivateEndpointConnectionResource
IotHubPrivateEndpointConnectionCollection collection = iotHubDescription.GetIotHubPrivateEndpointConnections();
// invoke the operation and iterate over the result
await foreach (IotHubPrivateEndpointConnectionResource 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
IotHubPrivateEndpointConnectionData 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
Przykładowa odpowiedź
[
{
"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": "Pending",
"description": "Please approve my request!",
"actionsRequired": "None"
}
}
}
]
Definicje
ErrorDetails
Szczegóły błędu.
| Nazwa |
Typ |
Opis |
|
code
|
string
|
Kod błędu.
|
|
details
|
string
|
Szczegóły błędu.
|
|
httpStatusCode
|
string
|
Kod stanu HTTP.
|
|
message
|
string
|
Komunikat o błędzie.
|
PrivateEndpoint
Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego
| Nazwa |
Typ |
Opis |
|
id
|
string
|
Identyfikator zasobu.
|
PrivateEndpointConnection
Połączenie prywatnego punktu końcowego usługi IotHub
| Nazwa |
Typ |
Opis |
|
id
|
string
|
Identyfikator zasobu.
|
|
name
|
string
|
Nazwa zasobu.
|
|
properties
|
PrivateEndpointConnectionProperties
|
Właściwości połączenia prywatnego punktu końcowego
|
|
type
|
string
|
Typ zasobu.
|
PrivateEndpointConnectionProperties
Właściwości połączenia prywatnego punktu końcowego
| Nazwa |
Typ |
Opis |
|
privateEndpoint
|
PrivateEndpoint
|
Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego
|
|
privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
Bieżący stan połączenia prywatnego punktu końcowego
|
PrivateLinkServiceConnectionState
Bieżący stan połączenia prywatnego punktu końcowego
| Nazwa |
Typ |
Opis |
|
actionsRequired
|
string
|
Akcje wymagane dla połączenia prywatnego punktu końcowego
|
|
description
|
string
|
Opis bieżącego stanu połączenia prywatnego punktu końcowego
|
|
status
|
PrivateLinkServiceConnectionStatus
|
Stan połączenia prywatnego punktu końcowego
|
PrivateLinkServiceConnectionStatus
Stan połączenia prywatnego punktu końcowego
| Nazwa |
Typ |
Opis |
|
Approved
|
string
|
|
|
Disconnected
|
string
|
|
|
Pending
|
string
|
|
|
Rejected
|
string
|
|