Microsoft.StreamAnalytics clusters/privateEndpoints

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",
  "name": "string",
  "properties": {
    "manualPrivateLinkServiceConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateLinkServiceConnectionState": {},
          "privateLinkServiceId": "string"
        }
      }
    ]
  }
}

Property values

clusters/privateEndpoints

Name Description Value
type The resource type 'Microsoft.StreamAnalytics/clusters/privateEndpoints'
apiVersion The resource api version '2020-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
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[]

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

PrivateLinkConnectionState

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.