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 storageSyncServices 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.StorageSync/storageSyncServices resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.StorageSync/storageSyncServices@2022-09-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
incomingTrafficPolicy: 'string'
useIdentity: bool
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.StorageSync/storageSyncServices
| Name | Description | Value |
|---|---|---|
| identity | managed identities for the Storage Sync to interact with other Azure services without maintaining any secrets or credentials in code. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The parameters used to create the storage sync service. | StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties
| Name | Description | Value |
|---|---|---|
| incomingTrafficPolicy | Incoming Traffic Policy | 'AllowAllTraffic' 'AllowVirtualNetworksOnly' |
| useIdentity | Use Identity authorization when customer have finished setup RBAC permissions. | bool |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The storageSyncServices 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.StorageSync/storageSyncServices resource, add the following JSON to your template.
{
"type": "Microsoft.StorageSync/storageSyncServices",
"apiVersion": "2022-09-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"incomingTrafficPolicy": "string",
"useIdentity": "bool"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.StorageSync/storageSyncServices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-09-01' |
| identity | managed identities for the Storage Sync to interact with other Azure services without maintaining any secrets or credentials in code. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The parameters used to create the storage sync service. | StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.StorageSync/storageSyncServices' |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties
| Name | Description | Value |
|---|---|---|
| incomingTrafficPolicy | Incoming Traffic Policy | 'AllowAllTraffic' 'AllowVirtualNetworksOnly' |
| useIdentity | Use Identity authorization when customer have finished setup RBAC permissions. | bool |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The storageSyncServices 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.StorageSync/storageSyncServices resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.StorageSync/storageSyncServices@2022-09-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
incomingTrafficPolicy = "string"
useIdentity = bool
}
}
}
Property Values
Microsoft.StorageSync/storageSyncServices
| Name | Description | Value |
|---|---|---|
| identity | managed identities for the Storage Sync to interact with other Azure services without maintaining any secrets or credentials in code. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The parameters used to create the storage sync service. | StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.StorageSync/storageSyncServices@2022-09-01" |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties
| Name | Description | Value |
|---|---|---|
| incomingTrafficPolicy | Incoming Traffic Policy | 'AllowAllTraffic' 'AllowVirtualNetworksOnly' |
| useIdentity | Use Identity authorization when customer have finished setup RBAC permissions. | bool |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|