Share via

Microsoft.StorageSync storageSyncServices/syncGroups

Bicep resource definition

The storageSyncServices/syncGroups 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.StorageSync/storageSyncServices/syncGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.StorageSync/storageSyncServices/syncGroups@2022-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: any(...)
}

Property Values

Microsoft.StorageSync/storageSyncServices/syncGroups

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: storageSyncServices
properties The parameters used to create the sync group any

ARM template resource definition

The storageSyncServices/syncGroups 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.StorageSync/storageSyncServices/syncGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.StorageSync/storageSyncServices/syncGroups",
  "apiVersion": "2022-09-01",
  "name": "string",
  "properties": {}
}

Property Values

Microsoft.StorageSync/storageSyncServices/syncGroups

Name Description Value
apiVersion The api version '2022-09-01'
name The resource name string (required)
properties The parameters used to create the sync group any
type The resource type 'Microsoft.StorageSync/storageSyncServices/syncGroups'

Usage Examples

Terraform (AzAPI provider) resource definition

The storageSyncServices/syncGroups 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.StorageSync/storageSyncServices/syncGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.StorageSync/storageSyncServices/syncGroups@2022-09-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = ?
  }
}

Property Values

Microsoft.StorageSync/storageSyncServices/syncGroups

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: storageSyncServices
properties The parameters used to create the sync group any
type The resource type "Microsoft.StorageSync/storageSyncServices/syncGroups@2022-09-01"

Usage Examples

Terraform Samples

A basic example of deploying Storage Sync Group.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageSyncService" {
  type      = "Microsoft.StorageSync/storageSyncServices@2020-03-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      incomingTrafficPolicy = "AllowAllTraffic"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "syncGroup" {
  type                      = "Microsoft.StorageSync/storageSyncServices/syncGroups@2020-03-01"
  parent_id                 = azapi_resource.storageSyncService.id
  name                      = var.resource_name
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on