azure-native.storagesync.SyncGroup
Explore with Pulumi AI
Sync Group object.
Uses Azure REST API version 2022-09-01. In version 2.x of the Azure Native provider, it used API version 2022-06-01.
Other available API versions: 2022-06-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storagesync [ApiVersion]
. See the version guide for details.
Create SyncGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SyncGroup(name: string, args: SyncGroupArgs, opts?: CustomResourceOptions);
@overload
def SyncGroup(resource_name: str,
args: SyncGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SyncGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
storage_sync_service_name: Optional[str] = None,
sync_group_name: Optional[str] = None)
func NewSyncGroup(ctx *Context, name string, args SyncGroupArgs, opts ...ResourceOption) (*SyncGroup, error)
public SyncGroup(string name, SyncGroupArgs args, CustomResourceOptions? opts = null)
public SyncGroup(String name, SyncGroupArgs args)
public SyncGroup(String name, SyncGroupArgs args, CustomResourceOptions options)
type: azure-native:storagesync:SyncGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SyncGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. SyncGroupArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SyncGroupArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SyncGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. SyncGroupArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeSyncGroupResource = new AzureNative.StorageSync.SyncGroup("azure-nativeSyncGroupResource", new()
{
ResourceGroupName = "string",
StorageSyncServiceName = "string",
SyncGroupName = "string",
});
example, err := storagesync.NewSyncGroup(ctx, "azure-nativeSyncGroupResource", &storagesync.SyncGroupArgs{
ResourceGroupName: pulumi.String("string"),
StorageSyncServiceName: pulumi.String("string"),
SyncGroupName: pulumi.String("string"),
})
var azure_nativeSyncGroupResource = new SyncGroup("azure-nativeSyncGroupResource", SyncGroupArgs.builder()
.resourceGroupName("string")
.storageSyncServiceName("string")
.syncGroupName("string")
.build());
azure_native_sync_group_resource = azure_native.storagesync.SyncGroup("azure-nativeSyncGroupResource",
resource_group_name="string",
storage_sync_service_name="string",
sync_group_name="string")
const azure_nativeSyncGroupResource = new azure_native.storagesync.SyncGroup("azure-nativeSyncGroupResource", {
resourceGroupName: "string",
storageSyncServiceName: "string",
syncGroupName: "string",
});
type: azure-native:storagesync:SyncGroup
properties:
resourceGroupName: string
storageSyncServiceName: string
syncGroupName: string
SyncGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SyncGroup resource accepts the following input properties:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Storage
Sync Service Name This property is required. Changes to this property will trigger replacement.
- Name of Storage Sync Service resource.
- Sync
Group Name Changes to this property will trigger replacement.
- Name of Sync Group resource.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Storage
Sync Service Name This property is required. Changes to this property will trigger replacement.
- Name of Storage Sync Service resource.
- Sync
Group Name Changes to this property will trigger replacement.
- Name of Sync Group resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- storage
Sync Service Name This property is required. Changes to this property will trigger replacement.
- Name of Storage Sync Service resource.
- sync
Group Name Changes to this property will trigger replacement.
- Name of Sync Group resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- storage
Sync Service Name This property is required. Changes to this property will trigger replacement.
- Name of Storage Sync Service resource.
- sync
Group Name Changes to this property will trigger replacement.
- Name of Sync Group resource.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- storage_
sync_ service_ name This property is required. Changes to this property will trigger replacement.
- Name of Storage Sync Service resource.
- sync_
group_ name Changes to this property will trigger replacement.
- Name of Sync Group resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- storage
Sync Service Name This property is required. Changes to this property will trigger replacement.
- Name of Storage Sync Service resource.
- sync
Group Name Changes to this property will trigger replacement.
- Name of Sync Group resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the SyncGroup resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Sync
Group stringStatus - Sync group status
- System
Data Pulumi.Azure Native. Storage Sync. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Unique
Id string - Unique Id
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Sync
Group stringStatus - Sync group status
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Unique
Id string - Unique Id
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- sync
Group StringStatus - Sync group status
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- unique
Id String - Unique Id
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- sync
Group stringStatus - Sync group status
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- unique
Id string - Unique Id
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- sync_
group_ strstatus - Sync group status
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- unique_
id str - Unique Id
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- sync
Group StringStatus - Sync group status
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- unique
Id String - Unique Id
Supporting Types
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:storagesync:SyncGroup SampleSyncGroup_1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0