Microsoft.StreamAnalytics clusters/privateEndpoints 2020-03-01-preview

Bicep resource definition

The clusters/privateEndpoints 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.StreamAnalytics/clusters/privateEndpoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.StreamAnalytics/clusters/privateEndpoints@2020-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    manualPrivateLinkServiceConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateLinkServiceConnectionState: {}
          privateLinkServiceId: 'string'
        }
      }
    ]
  }
}

Property Values

Microsoft.StreamAnalytics/clusters/privateEndpoints

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: clusters
properties The properties associated with a private endpoint. PrivateEndpointProperties

PrivateEndpointProperties

Name Description Value
manualPrivateLinkServiceConnections A list of connections to the remote resource. Immutable after it is set. PrivateLinkServiceConnection[]

PrivateLinkConnectionState

Name Description Value

PrivateLinkServiceConnection

Name Description Value
properties Bag of properties defining a privatelinkServiceConnection. PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

Name Description Value
groupIds The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests. string[]
privateLinkServiceConnectionState A collection of read-only information about the state of the connection to the private remote resource. PrivateLinkConnectionState
privateLinkServiceId The resource id of the private link service. Required on PUT (CreateOrUpdate) requests. string

ARM template resource definition

The clusters/privateEndpoints 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.StreamAnalytics/clusters/privateEndpoints resource, add the following JSON to your template.

{
  "type": "Microsoft.StreamAnalytics/clusters/privateEndpoints",
  "apiVersion": "2020-03-01-preview",
  "name": "string",
  "properties": {
    "manualPrivateLinkServiceConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateLinkServiceConnectionState": {
          },
          "privateLinkServiceId": "string"
        }
      }
    ]
  }
}

Property Values

Microsoft.StreamAnalytics/clusters/privateEndpoints

Name Description Value
apiVersion The api version '2020-03-01-preview'
name The resource name string (required)
properties The properties associated with a private endpoint. PrivateEndpointProperties
type The resource type 'Microsoft.StreamAnalytics/clusters/privateEndpoints'

PrivateEndpointProperties

Name Description Value
manualPrivateLinkServiceConnections A list of connections to the remote resource. Immutable after it is set. PrivateLinkServiceConnection[]

PrivateLinkConnectionState

Name Description Value

PrivateLinkServiceConnection

Name Description Value
properties Bag of properties defining a privatelinkServiceConnection. PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

Name Description Value
groupIds The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests. string[]
privateLinkServiceConnectionState A collection of read-only information about the state of the connection to the private remote resource. PrivateLinkConnectionState
privateLinkServiceId The resource id of the private link service. Required on PUT (CreateOrUpdate) requests. string

Usage Examples

Terraform (AzAPI provider) resource definition

The clusters/privateEndpoints 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.StreamAnalytics/clusters/privateEndpoints resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.StreamAnalytics/clusters/privateEndpoints@2020-03-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      manualPrivateLinkServiceConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateLinkServiceConnectionState = {
            }
            privateLinkServiceId = "string"
          }
        }
      ]
    }
  }
}

Property Values

Microsoft.StreamAnalytics/clusters/privateEndpoints

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: clusters
properties The properties associated with a private endpoint. PrivateEndpointProperties
type The resource type "Microsoft.StreamAnalytics/clusters/privateEndpoints@2020-03-01-preview"

PrivateEndpointProperties

Name Description Value
manualPrivateLinkServiceConnections A list of connections to the remote resource. Immutable after it is set. PrivateLinkServiceConnection[]

PrivateLinkConnectionState

Name Description Value

PrivateLinkServiceConnection

Name Description Value
properties Bag of properties defining a privatelinkServiceConnection. PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionProperties

Name Description Value
groupIds The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests. string[]
privateLinkServiceConnectionState A collection of read-only information about the state of the connection to the private remote resource. PrivateLinkConnectionState
privateLinkServiceId The resource id of the private link service. Required on PUT (CreateOrUpdate) requests. string
  • Last updated on