Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The storageAccounts/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.Storage/storageAccounts/connectors resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Storage/storageAccounts/connectors@2025-08-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
dataSourceType: 'string'
description: 'string'
source: {
type: 'string'
// For remaining properties, see StorageConnectorSource objects
}
state: 'string'
testConnection: bool
}
tags: {
{customized property}: 'string'
}
}
StorageConnectorConnection objects
Set the type property to specify the type of object.
For DataShare, use:
{
dataShareUri: 'string'
type: 'DataShare'
}
StorageConnectorSource objects
Set the type property to specify the type of object.
For DataShare, use:
{
authProperties: {
type: 'string'
// For remaining properties, see StorageConnectorAuthProperties objects
}
connection: {
type: 'string'
// For remaining properties, see StorageConnectorConnection objects
}
type: 'DataShare'
}
StorageConnectorAuthProperties objects
Set the type property to specify the type of object.
For ManagedIdentity, use:
{
identityResourceId: 'string'
type: 'ManagedIdentity'
}
Property Values
Microsoft.Storage/storageAccounts/connectors
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$ (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: storageAccounts |
| properties | The properties of the Storage Connector. | StorageConnectorProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
DataShareConnection
| Name | Description | Value |
|---|---|---|
| dataShareUri | The URI of the backing DataShare. Must be in the format: azds://<region>:<DataShareName>:<DataShareIdentifier> | string Constraints: Pattern = ^azds://[a-zA-Z0-9-]+:[a-zA-Z0-9-_]+:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required) |
| type | Type of the connection. Controls the type of the connection object. Not mutable once the Storage Connector is created. | 'DataShare' (required) |
DataShareSource
| Name | Description | Value |
|---|---|---|
| authProperties | Details for how to authenticate to the backing data store. | StorageConnectorAuthProperties (required) |
| connection | Details for how to connect to the backing data store. | StorageConnectorConnection (required) |
| type | Type of the Storage Connector. Not mutable once the Storage Connector is created." | 'DataShare' (required) |
ManagedIdentityAuthProperties
| Name | Description | Value |
|---|---|---|
| identityResourceId | ARM ResourceId of the managed identity that should be used to authenticate to the backing data source. | string |
| type | Type of the authentication properties. Controls the type of the authProperties object | 'ManagedIdentity' (required) |
StorageConnectorAuthProperties
| Name | Description | Value |
|---|---|---|
| type | Set to 'ManagedIdentity' for type ManagedIdentityAuthProperties. | 'ManagedIdentity' (required) |
StorageConnectorConnection
| Name | Description | Value |
|---|---|---|
| type | Set to 'DataShare' for type DataShareConnection. | 'DataShare' (required) |
StorageConnectorProperties
| Name | Description | Value |
|---|---|---|
| dataSourceType | The type of backing data source for this Storage Connector. | 'Azure_DataShare' (required) |
| description | Arbitrary description of this Storage Connector. Max 250 characters. | string Constraints: Max length = 250 |
| source | Information about how to communicate with and authenticate to the backing data store. | StorageConnectorSource (required) |
| state | State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise. |
'Active' 'Inactive' |
| testConnection | Test connection to backing data source before creating the storage connector. | bool |
StorageConnectorSource
| Name | Description | Value |
|---|---|---|
| type | Set to 'DataShare' for type DataShareSource. | 'DataShare' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The storageAccounts/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.Storage/storageAccounts/connectors resource, add the following JSON to your template.
{
"type": "Microsoft.Storage/storageAccounts/connectors",
"apiVersion": "2025-08-01",
"name": "string",
"location": "string",
"properties": {
"dataSourceType": "string",
"description": "string",
"source": {
"type": "string"
// For remaining properties, see StorageConnectorSource objects
},
"state": "string",
"testConnection": "bool"
},
"tags": {
"{customized property}": "string"
}
}
StorageConnectorConnection objects
Set the type property to specify the type of object.
For DataShare, use:
{
"dataShareUri": "string",
"type": "DataShare"
}
StorageConnectorSource objects
Set the type property to specify the type of object.
For DataShare, use:
{
"authProperties": {
"type": "string"
// For remaining properties, see StorageConnectorAuthProperties objects
},
"connection": {
"type": "string"
// For remaining properties, see StorageConnectorConnection objects
},
"type": "DataShare"
}
StorageConnectorAuthProperties objects
Set the type property to specify the type of object.
For ManagedIdentity, use:
{
"identityResourceId": "string",
"type": "ManagedIdentity"
}
Property Values
Microsoft.Storage/storageAccounts/connectors
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-08-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$ (required) |
| properties | The properties of the Storage Connector. | StorageConnectorProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Storage/storageAccounts/connectors' |
DataShareConnection
| Name | Description | Value |
|---|---|---|
| dataShareUri | The URI of the backing DataShare. Must be in the format: azds://<region>:<DataShareName>:<DataShareIdentifier> | string Constraints: Pattern = ^azds://[a-zA-Z0-9-]+:[a-zA-Z0-9-_]+:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required) |
| type | Type of the connection. Controls the type of the connection object. Not mutable once the Storage Connector is created. | 'DataShare' (required) |
DataShareSource
| Name | Description | Value |
|---|---|---|
| authProperties | Details for how to authenticate to the backing data store. | StorageConnectorAuthProperties (required) |
| connection | Details for how to connect to the backing data store. | StorageConnectorConnection (required) |
| type | Type of the Storage Connector. Not mutable once the Storage Connector is created." | 'DataShare' (required) |
ManagedIdentityAuthProperties
| Name | Description | Value |
|---|---|---|
| identityResourceId | ARM ResourceId of the managed identity that should be used to authenticate to the backing data source. | string |
| type | Type of the authentication properties. Controls the type of the authProperties object | 'ManagedIdentity' (required) |
StorageConnectorAuthProperties
| Name | Description | Value |
|---|---|---|
| type | Set to 'ManagedIdentity' for type ManagedIdentityAuthProperties. | 'ManagedIdentity' (required) |
StorageConnectorConnection
| Name | Description | Value |
|---|---|---|
| type | Set to 'DataShare' for type DataShareConnection. | 'DataShare' (required) |
StorageConnectorProperties
| Name | Description | Value |
|---|---|---|
| dataSourceType | The type of backing data source for this Storage Connector. | 'Azure_DataShare' (required) |
| description | Arbitrary description of this Storage Connector. Max 250 characters. | string Constraints: Max length = 250 |
| source | Information about how to communicate with and authenticate to the backing data store. | StorageConnectorSource (required) |
| state | State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise. |
'Active' 'Inactive' |
| testConnection | Test connection to backing data source before creating the storage connector. | bool |
StorageConnectorSource
| Name | Description | Value |
|---|---|---|
| type | Set to 'DataShare' for type DataShareSource. | 'DataShare' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The storageAccounts/connectors 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.Storage/storageAccounts/connectors resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Storage/storageAccounts/connectors@2025-08-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
dataSourceType = "string"
description = "string"
source = {
type = "string"
// For remaining properties, see StorageConnectorSource objects
}
state = "string"
testConnection = bool
}
}
}
StorageConnectorConnection objects
Set the type property to specify the type of object.
For DataShare, use:
{
dataShareUri = "string"
type = "DataShare"
}
StorageConnectorSource objects
Set the type property to specify the type of object.
For DataShare, use:
{
authProperties = {
type = "string"
// For remaining properties, see StorageConnectorAuthProperties objects
}
connection = {
type = "string"
// For remaining properties, see StorageConnectorConnection objects
}
type = "DataShare"
}
StorageConnectorAuthProperties objects
Set the type property to specify the type of object.
For ManagedIdentity, use:
{
identityResourceId = "string"
type = "ManagedIdentity"
}
Property Values
Microsoft.Storage/storageAccounts/connectors
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9](?!.*--)[a-z0-9-]{1,61}[a-z0-9]$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: storageAccounts |
| properties | The properties of the Storage Connector. | StorageConnectorProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Storage/storageAccounts/connectors@2025-08-01" |
DataShareConnection
| Name | Description | Value |
|---|---|---|
| dataShareUri | The URI of the backing DataShare. Must be in the format: azds://<region>:<DataShareName>:<DataShareIdentifier> | string Constraints: Pattern = ^azds://[a-zA-Z0-9-]+:[a-zA-Z0-9-_]+:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required) |
| type | Type of the connection. Controls the type of the connection object. Not mutable once the Storage Connector is created. | 'DataShare' (required) |
DataShareSource
| Name | Description | Value |
|---|---|---|
| authProperties | Details for how to authenticate to the backing data store. | StorageConnectorAuthProperties (required) |
| connection | Details for how to connect to the backing data store. | StorageConnectorConnection (required) |
| type | Type of the Storage Connector. Not mutable once the Storage Connector is created." | 'DataShare' (required) |
ManagedIdentityAuthProperties
| Name | Description | Value |
|---|---|---|
| identityResourceId | ARM ResourceId of the managed identity that should be used to authenticate to the backing data source. | string |
| type | Type of the authentication properties. Controls the type of the authProperties object | 'ManagedIdentity' (required) |
StorageConnectorAuthProperties
| Name | Description | Value |
|---|---|---|
| type | Set to 'ManagedIdentity' for type ManagedIdentityAuthProperties. | 'ManagedIdentity' (required) |
StorageConnectorConnection
| Name | Description | Value |
|---|---|---|
| type | Set to 'DataShare' for type DataShareConnection. | 'DataShare' (required) |
StorageConnectorProperties
| Name | Description | Value |
|---|---|---|
| dataSourceType | The type of backing data source for this Storage Connector. | 'Azure_DataShare' (required) |
| description | Arbitrary description of this Storage Connector. Max 250 characters. | string Constraints: Max length = 250 |
| source | Information about how to communicate with and authenticate to the backing data store. | StorageConnectorSource (required) |
| state | State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise. |
'Active' 'Inactive' |
| testConnection | Test connection to backing data source before creating the storage connector. | bool |
StorageConnectorSource
| Name | Description | Value |
|---|---|---|
| type | Set to 'DataShare' for type DataShareSource. | 'DataShare' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|