Partager via


Web Pub Sub Private Endpoint Connections - List

Répertorier les connexions de point de terminaison privé

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections?api-version=2024-03-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

resourceName
path True

string

Nom de la ressource.

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

subscriptionId
path True

string

uuid

ID de l’abonnement cible. La valeur doit être un UUID.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

PrivateEndpointConnectionList

Réussite. La réponse décrit une liste de connexions de point de terminaison privé.

Other Status Codes

ErrorResponse

Réponse d’erreur 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

WebPubSubPrivateEndpointConnections_List

Exemple de requête

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService/privateEndpointConnections?api-version=2024-03-01

Exemple de réponse

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
        },
        "groupIds": [
          "webpubsub"
        ],
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "actionsRequired": "None"
        }
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
      "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
      "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections",
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2015-02-03T04:05:06Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2015-02-03T04:05:06Z"
      }
    }
  ]
}

Définitions

Nom Description
createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

PrivateEndpoint

Point de terminaison privé

PrivateEndpointConnection

Connexion d’un point de terminaison privé à une ressource Azure

PrivateEndpointConnectionList

Liste des connexions de point de terminaison privé

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

ProvisioningState

État d’approvisionnement de la ressource.

systemData

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

createdByType

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

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

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

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

PrivateEndpoint

Point de terminaison privé

Nom Type Description
id

string

ID complet du point de terminaison privé

PrivateEndpointConnection

Connexion d’un point de terminaison privé à une ressource Azure

Nom Type Description
id

string

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

name

string

nom de la ressource.

properties.groupIds

string[]

ID de groupe

properties.privateEndpoint

PrivateEndpoint

Point de terminaison privé

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionList

Liste des connexions de point de terminaison privé

Nom Type Description
nextLink

string

URL de requête qui peut être utilisée pour interroger la page suivante des connexions de point de terminaison privé. Retourné lorsque le nombre total de connexions de point de terminaison privé demandées dépasse la taille maximale de page.

value

PrivateEndpointConnection[]

Liste des connexions de point de terminaison privé

PrivateLinkServiceConnectionState

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

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/du rejet de la connexion.

status

PrivateLinkServiceConnectionStatus

Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

PrivateLinkServiceConnectionStatus

Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

Nom Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

ProvisioningState

État d’approvisionnement de la ressource.

Nom Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Moving

string

Running

string

Succeeded

string

Unknown

string

Updating

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

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

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

lastModifiedByType

createdByType

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