Private Endpoint Connection - Create Or Update
Crea una nueva conexión de punto de conexión privado o actualiza una existente.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-08-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
private
|
path | True |
string |
Nombre de la conexión de punto de conexión privado. |
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
service
|
path | True |
string |
Nombre del servicio API Management. Regex pattern: |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso de conexión de punto de conexión privado. |
properties |
Estado de conexión de la conexión del punto de conexión privado. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Se completó la solicitud de conexión de punto de conexión privado. |
|
202 Accepted |
Solicite aprobar o rechazar la conexión de punto de conexión privado. El encabezado location contiene la dirección URL donde se puede comprobar el estado de la operación de larga duración. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
ApiManagementApproveOrRejectPrivateEndpointConnection
Sample Request
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."
}
}
}
Sample Response
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."
}
}
}
Definiciones
Nombre | Description |
---|---|
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
Private |
Recurso de punto de conexión privado. |
Private |
Recurso de conexión de punto de conexión privado. |
Private |
Estado de aprovisionamiento actual. |
Private |
Una solicitud para aprobar o rechazar una conexión de punto de conexión privado |
Private |
Estado de conexión del punto de conexión privado. |
Private |
Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor. |
Properties |
Estado de conexión de la conexión del punto de conexión privado. |
ErrorFieldContract
Contrato de campo de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error de nivel de propiedad. |
message |
string |
Representación legible del error de nivel de propiedad. |
target |
string |
Nombre de propiedad. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error.code |
string |
Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta. |
error.details |
La lista de campos no válidos que se envían en la solicitud, en caso de error de validación. |
|
error.message |
string |
Representación legible del error. |
PrivateEndpoint
Recurso de punto de conexión privado.
Nombre | Tipo | Description |
---|---|---|
id |
string |
El identificador de ARM para el punto de conexión privado |
PrivateEndpointConnection
Recurso de conexión de punto de conexión privado.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nombre del recurso. |
properties.privateEndpoint |
Recurso del punto de conexión privado. |
|
properties.privateLinkServiceConnectionState |
Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor. |
|
properties.provisioningState |
Estado de aprovisionamiento del recurso de conexión de punto de conexión privado. |
|
type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
Estado de aprovisionamiento actual.
Nombre | Tipo | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointConnectionRequest
Una solicitud para aprobar o rechazar una conexión de punto de conexión privado
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso de conexión de punto de conexión privado. |
properties |
Estado de conexión de la conexión del punto de conexión privado. |
PrivateEndpointServiceConnectionStatus
Estado de conexión del punto de conexión privado.
Nombre | Tipo | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
Nombre | Tipo | Description |
---|---|---|
actionsRequired |
string |
Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor. |
description |
string |
Motivo de aprobación o rechazo de la conexión. |
status |
Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión. |
Properties
Estado de conexión de la conexión del punto de conexión privado.
Nombre | Tipo | Description |
---|---|---|
privateLinkServiceConnectionState |
Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor. |