Share via

Microsoft.Sql managedInstances/privateEndpointConnections 2023-08-01-preview

  • Article

Bicep resource definition

The managedInstances/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/managedInstances/privateEndpointConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/managedInstances/privateEndpointConnections@2023-08-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      description: 'string'
      status: 'string'
    }
  }
}

Property values

ManagedInstancePrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Private endpoint which the connection belongs to. ManagedInstancePrivateEndpointProperty
privateLinkServiceConnectionState Connection State of the Private Endpoint Connection. ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstancePrivateEndpointProperty

Name Description Value
id Resource id of the private endpoint. string

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Description Value
description The private link service connection description. string (required)
status The private link service connection status. string (required)

Microsoft.Sql/managedInstances/privateEndpointConnections

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: managedInstances
properties Resource properties. ManagedInstancePrivateEndpointConnectionProperties

ARM template resource definition

The managedInstances/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/managedInstances/privateEndpointConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/managedInstances/privateEndpointConnections",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "properties": {
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "description": "string",
      "status": "string"
    }
  }
}

Property values

ManagedInstancePrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Private endpoint which the connection belongs to. ManagedInstancePrivateEndpointProperty
privateLinkServiceConnectionState Connection State of the Private Endpoint Connection. ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstancePrivateEndpointProperty

Name Description Value
id Resource id of the private endpoint. string

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Description Value
description The private link service connection description. string (required)
status The private link service connection status. string (required)

Microsoft.Sql/managedInstances/privateEndpointConnections

Name Description Value
apiVersion The api version '2023-08-01-preview'
name The resource name string (required)
properties Resource properties. ManagedInstancePrivateEndpointConnectionProperties
type The resource type 'Microsoft.Sql/managedInstances/privateEndpointConnections'

Terraform (AzAPI provider) resource definition

The managedInstances/privateEndpointConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/managedInstances/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/managedInstances/privateEndpointConnections@2023-08-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      privateEndpoint = {
        id = "string"
      }
      privateLinkServiceConnectionState = {
        description = "string"
        status = "string"
      }
    }
  })
}

Property values

ManagedInstancePrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Private endpoint which the connection belongs to. ManagedInstancePrivateEndpointProperty
privateLinkServiceConnectionState Connection State of the Private Endpoint Connection. ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstancePrivateEndpointProperty

Name Description Value
id Resource id of the private endpoint. string

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Description Value
description The private link service connection description. string (required)
status The private link service connection status. string (required)

Microsoft.Sql/managedInstances/privateEndpointConnections

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: managedInstances
properties Resource properties. ManagedInstancePrivateEndpointConnectionProperties
type The resource type "Microsoft.Sql/managedInstances/privateEndpointConnections@2023-08-01-preview"