Private Endpoint Connection - Create Or Update
Crée une connexion de point de terminaison privé ou met à jour une connexion existante.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-08-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
private
|
path | True |
string |
Nom de la connexion de point de terminaison privé. |
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
service
|
path | True |
string |
Nom du service Gestion des API. Modèle d’expression régulière: |
subscription
|
path | True |
string |
ID de l’abonnement cible. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource de connexion de point de terminaison privé. |
properties |
État de la connexion de la connexion de point de terminaison privé. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La demande de connexion de point de terminaison privé a été effectuée. |
|
202 Accepted |
Demande d’approbation ou de rejet d’une connexion de point de terminaison privé. L’en-tête Location contient l’URL dans laquelle les status de l’opération de longue durée peuvent être vérifiées. |
|
Other Status Codes |
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
ApiManagementApproveOrRejectPrivateEndpointConnection
Exemple de requête
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName?api-version=2022-08-01
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "The Private Endpoint Connection is approved."
}
}
}
Exemple de réponse
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
"name": "privateEndpointConnectionName",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Succeeded",
"description": "The request has been approved."
}
}
}
Définitions
Nom | Description |
---|---|
Error |
Contrat champ d’erreur. |
Error |
Réponse d’erreur. |
Private |
Ressource de point de terminaison privé. |
Private |
Ressource de connexion de point de terminaison privé. |
Private |
État d’approvisionnement actuel. |
Private |
Demande d’approbation ou de rejet d’une connexion de point de terminaison privé |
Private |
La connexion de point de terminaison privé status. |
Private |
Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. |
Properties |
État de la connexion de la connexion de point de terminaison privé. |
ErrorFieldContract
Contrat champ d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'erreur de niveau propriété. |
message |
string |
Représentation lisible par l’homme de l’erreur au niveau de la propriété. |
target |
string |
Nom de propriété. |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error.code |
string |
Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse. |
error.details |
Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation. |
|
error.message |
string |
Représentation contrôlable de visu de l’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 |
Ressource du point de terminaison privé. |
|
properties.privateLinkServiceConnectionState |
Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. |
|
properties.provisioningState |
É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 |
PrivateEndpointConnectionRequest
Demande d’approbation ou de rejet d’une connexion de point de terminaison privé
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource de connexion de point de terminaison privé. |
properties |
État de la connexion de la connexion de point de terminaison privé. |
PrivateEndpointServiceConnectionStatus
La connexion de point de terminaison privé status.
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/du rejet de la connexion. |
status |
Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. |
Properties
État de la connexion de la connexion de point de terminaison privé.
Nom | Type | Description |
---|---|---|
privateLinkServiceConnectionState |
Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur. |