Skip to content

Data Source: azurermStorageSync

Use this data source to access information about an existing Storage Sync.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermStorageSyncExample =
  new azurerm.dataAzurermStorageSync.DataAzurermStorageSync(this, "example", {
    name: "existingStorageSyncName",
    resource_group_name: "existingResGroup",
  });
new cdktf.TerraformOutput(this, "id", {
  value: dataAzurermStorageSyncExample.id,
});

Arguments Reference

The following arguments are supported:

  • name - (Required) The name of this Storage Sync.

  • resourceGroupName - (Required) The name of the Resource Group where the Storage Sync exists.

Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Storage Sync.

  • incomingTrafficPolicy - Incoming traffic policy.

  • location - The Azure Region where the Storage Sync exists.

  • tags - A mapping of tags assigned to the Storage Sync.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Storage Sync.