Microsoft.ServiceLinker locations/connectors

Article
12/09/2024

Bicep resource definition

The locations/connectors resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

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

Resource format

To create a Microsoft.ServiceLinker/locations/connectors resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ServiceLinker/locations/connectors@2024-07-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authInfo: {
      authMode: 'string'
      authType: 'string'
      // For remaining properties, see AuthInfoBase objects
    }
    clientType: 'string'
    configurationInfo: {
      action: 'string'
      additionalConfigurations: {
        {customized property}: 'string'
      }
      additionalConnectionStringProperties: {
        {customized property}: 'string'
      }
      configurationStore: {
        appConfigurationId: 'string'
      }
      customizedKeys: {
        {customized property}: 'string'
      }
      daprProperties: {
        componentType: 'string'
        metadata: [
          {
            description: 'string'
            name: 'string'
            required: 'string'
            secretRef: 'string'
            value: 'string'
          }
        ]
        scopes: [
          'string'
        ]
        secretStoreComponent: 'string'
        version: 'string'
      }
      deleteOrUpdateBehavior: 'string'
    }
    publicNetworkSolution: {
      action: 'string'
      deleteOrUpdateBehavior: 'string'
      firewallRules: {
        azureServices: 'string'
        callerClientIP: 'string'
        ipRanges: [
          'string'
        ]
      }
    }
    scope: 'string'
    secretStore: {
      keyVaultId: 'string'
      keyVaultSecretName: 'string'
    }
    targetService: {
      type: 'string'
      // For remaining properties, see TargetServiceBase objects
    }
    vNetSolution: {
      deleteOrUpdateBehavior: 'string'
      type: 'string'
    }
  }
}

AuthInfoBase objects

Set the authType property to specify the type of object.

For accessKey, use:

{
  authType: 'accessKey'
  permissions: [
    'string'
  ]
}

For easyAuthMicrosoftEntraID, use:

{
  authType: 'easyAuthMicrosoftEntraID'
  clientId: 'string'
  deleteOrUpdateBehavior: 'string'
  secret: 'string'
}

For secret, use:

{
  authType: 'secret'
  name: 'string'
  secretInfo: {
    secretType: 'string'
    // For remaining properties, see SecretInfoBase objects
  }
}

For servicePrincipalCertificate, use:

{
  authType: 'servicePrincipalCertificate'
  certificate: 'string'
  clientId: 'string'
  deleteOrUpdateBehavior: 'string'
  principalId: 'string'
  roles: [
    'string'
  ]
}

For servicePrincipalSecret, use:

{
  authType: 'servicePrincipalSecret'
  clientId: 'string'
  deleteOrUpdateBehavior: 'string'
  principalId: 'string'
  roles: [
    'string'
  ]
  secret: 'string'
  userName: 'string'
}

For systemAssignedIdentity, use:

{
  authType: 'systemAssignedIdentity'
  deleteOrUpdateBehavior: 'string'
  roles: [
    'string'
  ]
  userName: 'string'
}

For userAccount, use:

{
  authType: 'userAccount'
  deleteOrUpdateBehavior: 'string'
  principalId: 'string'
  roles: [
    'string'
  ]
  userName: 'string'
}

For userAssignedIdentity, use:

{
  authType: 'userAssignedIdentity'
  clientId: 'string'
  deleteOrUpdateBehavior: 'string'
  roles: [
    'string'
  ]
  subscriptionId: 'string'
  userName: 'string'
}

TargetServiceBase objects

Set the type property to specify the type of object.

For AzureResource, use:

{
  id: 'string'
  resourceProperties: {
    type: 'string'
    // For remaining properties, see AzureResourcePropertiesBase objects
  }
  type: 'AzureResource'
}

For ConfluentBootstrapServer, use:

{
  endpoint: 'string'
  type: 'ConfluentBootstrapServer'
}

For ConfluentSchemaRegistry, use:

{
  endpoint: 'string'
  type: 'ConfluentSchemaRegistry'
}

For FabricPlatform, use:

{
  endpoint: 'string'
  type: 'FabricPlatform'
}

For SelfHostedServer, use:

{
  endpoint: 'string'
  type: 'SelfHostedServer'
}

SecretInfoBase objects

Set the secretType property to specify the type of object.

For keyVaultSecretReference, use:

{
  name: 'string'
  secretType: 'keyVaultSecretReference'
  version: 'string'
}

For keyVaultSecretUri, use:

{
  secretType: 'keyVaultSecretUri'
  value: 'string'
}

For rawValue, use:

{
  secretType: 'rawValue'
  value: 'string'
}

AzureResourcePropertiesBase objects

Set the type property to specify the type of object.

For AppConfig, use:

{
  connectWithKubernetesExtension: bool
  type: 'AppConfig'
}

For KeyVault, use:

{
  connectAsKubernetesCsiDriver: bool
  type: 'KeyVault'
}

Property Values

AccessKeyInfoBase

Name	Description	Value
authType	The authentication type.	'accessKey' (required)
permissions	Permissions of the accessKey. `Read` and `Write` are for Azure Cosmos DB and Azure App Configuration, `Listen`, `Send` and `Manage` are for Azure Event Hub and Azure Service Bus.	String array containing any of: 'Listen' 'Manage' 'Read' 'Send' 'Write'

AuthInfoBase

Name	Description	Value
authMode	Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth.	'optInAllAuth' 'optOutAllAuth'
authType	Set to 'accessKey' for type AccessKeyInfoBase. Set to 'easyAuthMicrosoftEntraID' for type EasyAuthMicrosoftEntraIDAuthInfo. Set to 'secret' for type SecretAuthInfo. Set to 'servicePrincipalCertificate' for type ServicePrincipalCertificateAuthInfo. Set to 'servicePrincipalSecret' for type ServicePrincipalSecretAuthInfo. Set to 'systemAssignedIdentity' for type SystemAssignedIdentityAuthInfo. Set to 'userAccount' for type UserAccountAuthInfo. Set to 'userAssignedIdentity' for type UserAssignedIdentityAuthInfo.	'accessKey' 'easyAuthMicrosoftEntraID' 'secret' 'servicePrincipalCertificate' 'servicePrincipalSecret' 'systemAssignedIdentity' 'userAccount' 'userAssignedIdentity' (required)

AzureAppConfigProperties

Name	Description	Value
connectWithKubernetesExtension	True if connection enables app configuration kubernetes extension.	bool
type	The azure resource type.	'AppConfig' (required)

AzureKeyVaultProperties

Name	Description	Value
connectAsKubernetesCsiDriver	True if connect via Kubernetes CSI Driver.	bool
type	The azure resource type.	'KeyVault' (required)

AzureResource

Name	Description	Value
id	The Id of azure resource.	string
resourceProperties	The azure resource connection related properties.	AzureResourcePropertiesBase
type	The target service type.	'AzureResource' (required)

AzureResourcePropertiesBase

Name	Description	Value
type	Set to 'AppConfig' for type AzureAppConfigProperties. Set to 'KeyVault' for type AzureKeyVaultProperties.	'AppConfig' 'KeyVault' (required)

ConfigurationInfo

Name	Description	Value
action	Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source.	'enable' 'Internal' 'optOut'
additionalConfigurations	A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations	ConfigurationInfoAdditionalConfigurations
additionalConnectionStringProperties	A dictionary of additional properties to be added in the end of connection string.	ConfigurationInfoAdditionalConnectionStringProperties
configurationStore	An option to store configuration into different place	ConfigurationStore
customizedKeys	Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations	ConfigurationInfoCustomizedKeys
daprProperties	Indicates some additional properties for dapr client type	DaprProperties
deleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting	'Default' 'ForcedCleanup'

ConfigurationInfoAdditionalConfigurations

Name	Description	Value

ConfigurationInfoAdditionalConnectionStringProperties

Name	Description	Value

ConfigurationInfoCustomizedKeys

Name	Description	Value

ConfigurationStore

Name	Description	Value
appConfigurationId	The app configuration id to store configuration	string

ConfluentBootstrapServer

Name	Description	Value
endpoint	The endpoint of service.	string
type	The target service type.	'ConfluentBootstrapServer' (required)

ConfluentSchemaRegistry

Name	Description	Value
endpoint	The endpoint of service.	string
type	The target service type.	'ConfluentSchemaRegistry' (required)

DaprMetadata

Name	Description	Value
description	The description of the metadata, returned from configuration api	string
name	Metadata property name.	string
required	The value indicating whether the metadata is required or not	'false' 'true'
secretRef	The secret name where dapr could get value	string
value	Metadata property value.	string

DaprProperties

Name	Description	Value
componentType	The dapr component type	string
metadata	Additional dapr metadata	DaprMetadata[]
scopes	The dapr component scopes	string[]
secretStoreComponent	The name of a secret store dapr to retrieve secret	string
version	The dapr component version	string

EasyAuthMicrosoftEntraIDAuthInfo

Name	Description	Value
authType	The authentication type.	'easyAuthMicrosoftEntraID' (required)
clientId	Application clientId for EasyAuth Microsoft Entra ID.	string
deleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting	'Default' 'ForcedCleanup'
secret	Application Secret for EasyAuth Microsoft Entra ID.	string Constraints: Sensitive value. Pass in as a secure parameter.

FabricPlatform

Name	Description	Value
endpoint	The endpoint of service.	string
type	The target service type.	'FabricPlatform' (required)

FirewallRules

Name	Description	Value
azureServices	Allow Azure services to access the target service if true.	'false' 'true'
callerClientIP	Allow caller client IP to access the target service if true. the property is used when connecting local application to target service.	'false' 'true'
ipRanges	This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account.	string[]

KeyVaultSecretReferenceSecretInfo

Name	Description	Value
name	Name of the Key Vault secret.	string
secretType	The secret type.	'keyVaultSecretReference' (required)
version	Version of the Key Vault secret.	string

KeyVaultSecretUriSecretInfo

Name	Description	Value
secretType	The secret type.	'keyVaultSecretUri' (required)
value	URI to the keyvault secret	string

LinkerProperties

Name	Description	Value
authInfo	The authentication type.	AuthInfoBase
clientType	The application client type	'dapr' 'django' 'dotnet' 'go' 'java' 'jms-springBoot' 'kafka-springBoot' 'nodejs' 'none' 'php' 'python' 'ruby' 'springBoot'
configurationInfo	The connection information consumed by applications, including secrets, connection strings.	ConfigurationInfo
publicNetworkSolution	The network solution.	PublicNetworkSolution
scope	connection scope in source service.	string
secretStore	An option to store secret value in secure place	SecretStore
targetService	The target service properties	TargetServiceBase
vNetSolution	The VNet solution.	VNetSolution