Excluir conexão de ponto de extremidade privado com o nome especificado
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-06-30
Parâmetros de URI
Nome |
Em |
Obrigatório |
Tipo |
Description |
privateEndpointConnectionName
|
path |
True
|
string
|
O nome da conexão de ponto de extremidade privado
|
resourceGroupName
|
path |
True
|
string
|
O nome do grupo de recursos que contém o hub IoT.
|
resourceName
|
path |
True
|
string
|
O nome do Hub IoT.
|
subscriptionId
|
path |
True
|
string
|
O identificador da assinatura.
|
api-version
|
query |
True
|
string
|
A versão da API.
|
Respostas
Nome |
Tipo |
Description |
200 OK
|
PrivateEndpointConnection
|
Isso é retornado como uma resposta ao status solicitação de sondagem para a operação de exclusão.
|
202 Accepted
|
PrivateEndpointConnection
|
Essa é uma operação em execução longa. A operação retornará um 202 se a validação for concluída. A resposta inclui um cabeçalho Azure-AsyncOperation que contém uma URL status. Espera-se que os clientes sondam a URL de status para o status da operação.
Cabeçalhos
- Azure-AsyncOperation: string
- Location: string
|
204 No Content
|
|
PrivateEndpoint não existe.
|
Other Status Codes
|
ErrorDetails
|
DefaultErrorResponse
|
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome |
Description |
user_impersonation
|
representar sua conta de usuário
|
Exemplos
PrivateEndpointConnection_Delete
Solicitação de exemplo
DELETE https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/iotHubs/testHub/privateEndpointConnections/myPrivateEndpointConnection?api-version=2023-06-30
/**
* Samples for PrivateEndpointConnections Delete.
*/
public final class Main {
/*
* x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/
* iothub_deleteprivateendpointconnection.json
*/
/**
* Sample code: PrivateEndpointConnection_Delete.
*
* @param manager Entry point to IotHubManager.
*/
public static void privateEndpointConnectionDelete(com.azure.resourcemanager.iothub.IotHubManager manager) {
manager.privateEndpointConnections().delete("myResourceGroup", "testHub", "myPrivateEndpointConnection",
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_deleteprivateendpointconnection.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.begin_delete(
resource_group_name="myResourceGroup",
resource_name="testHub",
private_endpoint_connection_name="myPrivateEndpointConnection",
).result()
print(response)
# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_deleteprivateendpointconnection.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_deleteprivateendpointconnection.json
func ExamplePrivateEndpointConnectionsClient_BeginDelete() {
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)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginDelete(ctx, "myResourceGroup", "testHub", "myPrivateEndpointConnection", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %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.PrivateEndpointConnection = 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("Deleted"),
// ActionsRequired: to.Ptr("None"),
// Status: to.Ptr(armiothub.PrivateLinkServiceConnectionStatusDisconnected),
// },
// },
// }
}
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 Delete private endpoint connection with the specified name
*
* @summary Delete private endpoint connection with the specified name
* x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_deleteprivateendpointconnection.json
*/
async function privateEndpointConnectionDelete() {
const subscriptionId =
process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
const resourceName = "testHub";
const privateEndpointConnectionName = "myPrivateEndpointConnection";
const credential = new DefaultAzureCredential();
const client = new IotHubClient(credential, subscriptionId);
const result = await client.privateEndpointConnections.beginDeleteAndWait(
resourceGroupName,
resourceName,
privateEndpointConnectionName
);
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_deleteprivateendpointconnection.json
// this example is just showing the usage of "PrivateEndpointConnections_Delete" 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 IotHubPrivateEndpointConnectionResource created on azure
// for more information of creating IotHubPrivateEndpointConnectionResource, please refer to the document of IotHubPrivateEndpointConnectionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
string resourceName = "testHub";
string privateEndpointConnectionName = "myPrivateEndpointConnection";
ResourceIdentifier iotHubPrivateEndpointConnectionResourceId = IotHubPrivateEndpointConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName);
IotHubPrivateEndpointConnectionResource iotHubPrivateEndpointConnection = client.GetIotHubPrivateEndpointConnectionResource(iotHubPrivateEndpointConnectionResourceId);
// invoke the operation
ArmOperation<IotHubPrivateEndpointConnectionResource> lro = await iotHubPrivateEndpointConnection.DeleteAsync(WaitUntil.Completed);
IotHubPrivateEndpointConnectionResource result = lro.Value;
// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Resposta de exemplo
{
"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": "Disconnected",
"description": "Deleted",
"actionsRequired": "None"
}
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2023-06-30-preview&operationSource=os_ih&asyncinfo
Location: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2022-11-01-preview&operationSource=os_ih
{
"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": "Disconnected",
"description": "Deleted",
"actionsRequired": "None"
}
}
}
Definições
ErrorDetails
Detalhes do erro.
Nome |
Tipo |
Description |
code
|
string
|
O código de erro.
|
details
|
string
|
Os detalhes do erro.
|
httpStatusCode
|
string
|
O código de status do HTTP.
|
message
|
string
|
A mensagem de erro.
|
PrivateEndpoint
A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado
Nome |
Tipo |
Description |
id
|
string
|
O identificador do recurso.
|
PrivateEndpointConnection
A conexão de ponto de extremidade privado de um IotHub
Nome |
Tipo |
Description |
id
|
string
|
O identificador do recurso.
|
name
|
string
|
O nome do recurso.
|
properties
|
PrivateEndpointConnectionProperties
|
As propriedades de uma conexão de ponto de extremidade privado
|
type
|
string
|
O tipo de recurso.
|
PrivateEndpointConnectionProperties
As propriedades de uma conexão de ponto de extremidade privado
Nome |
Tipo |
Description |
privateEndpoint
|
PrivateEndpoint
|
A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado
|
privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
O estado atual de uma conexão de ponto de extremidade privado
|
PrivateLinkServiceConnectionState
O estado atual de uma conexão de ponto de extremidade privado
Nome |
Tipo |
Description |
actionsRequired
|
string
|
Ações necessárias para uma conexão de ponto de extremidade privado
|
description
|
string
|
A descrição do estado atual de uma conexão de ponto de extremidade privado
|
status
|
PrivateLinkServiceConnectionStatus
|
O status de uma conexão de ponto de extremidade privado
|
PrivateLinkServiceConnectionStatus
O status de uma conexão de ponto de extremidade privado
Nome |
Tipo |
Description |
Approved
|
string
|
|
Disconnected
|
string
|
|
Pending
|
string
|
|
Rejected
|
string
|
|