Private Endpoint Connections - Create Or Update

Crée ou met à jour PrivateEndpointConnections de l’espace de noms de service.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-01-01

Paramètres URI

Nom Dans Obligatoire Type Description
namespaceName
path True

string

Nom de l’espace de noms

Modèle d’expression régulière: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

privateEndpointConnectionName
path True

string

Nom PrivateEndpointConnection

resourceGroupName
path True

string

Nom du groupe de ressources au sein de l’abonnement Azure.

subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True

string

Version de l’API cliente.

Corps de la demande

Nom Type Description
properties.privateEndpoint

PrivateEndpoint

Ressource de point de terminaison privé pour cette connexion.

properties.privateLinkServiceConnectionState

ConnectionState

Détails sur l’état de la connexion.

properties.provisioningState

EndPointProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Réponses

Nom Type Description
200 OK

PrivateEndpointConnection

État de la connexion PrivateEndPoint créée avec succès.

201 Created

PrivateEndpointConnection

Demande de mise à jour de l’état de la connexion PrivateEndPoint acceptée.

202 Accepted

PrivateEndpointConnection

Demande de mise à jour de l’état de la connexion PrivateEndPoint acceptée.

Other Status Codes

ErrorResponse

Réponse d’erreur Eventhub décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

NameSpacePrivateEndPointConnectionCreate

Exemple de requête

PUT https://management.azure.com/subscriptions/subID/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2924/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-01-01

{
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "testing"
    },
    "provisioningState": "Succeeded"
  }
}

Exemple de réponse

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}
{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}
{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Définitions

Nom Description
ConnectionState

Informations ConnectionState.

createdByType

Type d’identité qui a créé la ressource.

EndPointProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la demande entrante. La raison est fournie dans le message d’erreur.

PrivateEndpoint

Informations PrivateEndpoint.

PrivateEndpointConnection

Propriétés de PrivateEndpointConnection.

PrivateLinkConnectionStatus

État de la connexion.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

ConnectionState

Informations ConnectionState.

Nom Type Description
description

string

Description de l’état de la connexion.

status

PrivateLinkConnectionStatus

État de la connexion.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

EndPointProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Nom Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la demande entrante. La raison est fournie dans le message d’erreur.

Nom Type Description
error

ErrorDetail

Objet d’erreur.

PrivateEndpoint

Informations PrivateEndpoint.

Nom Type Description
id

string

Identificateur ARM pour le point de terminaison privé.

PrivateEndpointConnection

Propriétés de PrivateEndpointConnection.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Emplacement géographique où réside la ressource

name

string

nom de la ressource.

properties.privateEndpoint

PrivateEndpoint

Ressource de point de terminaison privé pour cette connexion.

properties.privateLinkServiceConnectionState

ConnectionState

Détails sur l’état de la connexion.

properties.provisioningState

EndPointProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

systemData

systemData

Métadonnées système relatives à cette ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.EventHub/Namespaces » ou « Microsoft.EventHub/Namespaces/EventHubs »

PrivateLinkConnectionStatus

État de la connexion.

Nom Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Type d’identité qui a modifié la dernière ressource.

lastModifiedBy

string

Identité qui a modifié la dernière ressource.

lastModifiedByType

createdByType

Type d’identité qui a modifié la dernière ressource.