Private Endpoint Connections - Get

Référence

Service:: Redis Cache

Version d'API:: 2024-10-01

Obtient la connexion de point de terminaison privé spécifiée associée au cluster RedisEnterprise.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-10-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
clusterName	path	True	string	Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs Modèle d’expression régulière: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
privateEndpointConnectionName	path	True	string	Nom de la connexion de point de terminaison privé associée à la ressource Azure
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	PrivateEndpointConnection	OK : obtenez les propriétés de connexion de point de terminaison privé avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

RedisEnterpriseGetPrivateEndpointConnection

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01?api-version=2024-10-01

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01",
  "name": "pectest01",
  "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved",
      "actionsRequired": "None"
    }
  }
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
PrivateEndpoint	Ressource de point de terminaison privé.
PrivateEndpointConnection	Ressource de connexion de point de terminaison privé.
PrivateEndpointConnectionProvisioningState	État d’approvisionnement actuel.
PrivateEndpointServiceConnectionStatus	État de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionState	Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

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émentaire.

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

PrivateEndpoint

Ressource de point de terminaison privé.

Nom	Type	Description
id	string	Identificateur ARM pour le point de terminaison privé

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.privateEndpoint	PrivateEndpoint	Ressource du point de terminaison privé.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la ressource de connexion de point de terminaison privé.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.

Nom	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

Nom	Type	Description
actionsRequired	string	Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
description	string	Raison de l’approbation/rejet de la connexion.
status	PrivateEndpointServiceConnectionStatus	Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

Partager via