Share via

Managed Instance Private Endpoint Connections - Create Or Update

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Approve or reject a private endpoint connection with a given name.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2021-11-01

URI Parameters

Name In Required Type Description
managedInstanceName
 path True

string

The name of the managed instance.
privateEndpointConnectionName
 path True

string

resourceGroupName
 path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId
 path True

string

The subscription ID that identifies an Azure subscription.
api-version
 query True

string

The API version to use for the request.

Request Body

Name Type Description
properties.privateEndpoint

ManagedInstancePrivateEndpointProperty

Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState

ManagedInstancePrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

Responses

Name Type Description
200 OK

ManagedInstancePrivateEndpointConnection

Successfully approved or rejected private endpoint connection.
202 Accepted

Accepted
Other Status Codes

*** Error Responses: ***

  • 400 PrivateEndpointConnectionDoesNotExist - Private Endpoint Connection does not exist

  • 400 PrivateEndpointConnectionStatusNotPending - Private Endpoint Connection Status is not Pending

  • 400 NullRemotePrivateLinkServiceConnectionState - Remote Private Link Service Connection State is Null

  • 400 NullPrivateEndpointConnectionProperties - Private Endpoint Connection Properties is Null

  • 400 NullRemotePrivateLinkServiceConnectionStateStatus - Remote Private Link Service Connection State Status is Null

  • 400 IncorrectPrivateLinkServiceConnectionStateStatus - Private Link Service Connection State Status must be "Approved" or "Rejected"

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 404 OperationIdNotFound - The operation with Id does not exist.

  • 409 OperationCancelled - The operation has been cancelled by user.

  • 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.

  • 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.

  • 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.

  • 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.

  • 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Approve or reject a private endpoint connection with a given name.

Sample request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/test-cl/privateEndpointConnections/private-endpoint-connection-name?api-version=2021-11-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by [email protected]"
    }
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/test-cl/privateEndpointConnections/private-endpoint-connection-name",
  "name": "private-endpoint-connection-name",
  "type": "Microsoft.Sql/managedInstances/privateEndpointConnections",
  "properties": {
    "provisioningState": "Ready",
    "privateEndpoint": {
      "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by [email protected]",
      "actionsRequired": "None"
    }
  }
}
Status code:
202

Definitions

Name Description
ManagedInstancePrivateEndpointConnection

A private endpoint connection
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstancePrivateEndpointConnection

A private endpoint connection

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.privateEndpoint

ManagedInstancePrivateEndpointProperty

Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState

ManagedInstancePrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.
properties.provisioningState

string

State of the Private Endpoint Connection.
type

string

Resource type.

ManagedInstancePrivateEndpointProperty

Name Type Description
id

string

Resource id of the private endpoint.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Type Description
actionsRequired

string

The private link service connection description.
description

string

The private link service connection description.
status

string

The private link service connection status.