Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Synced Folder
  3. API Docs
  4. AzureBlobFolder
Synced Folder v0.11.1 published on Wednesday, Aug 2, 2023 by Pulumi
pulumi/pulumi-synced-folder

synced-folder.AzureBlobFolder

Explore with Pulumi AI

synced-folder logo
Synced Folder v0.11.1 published on Wednesday, Aug 2, 2023 by Pulumi
pulumi/pulumi-synced-folder

    Create AzureBlobFolder Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AzureBlobFolder(name: string, args: AzureBlobFolderArgs, opts?: ComponentResourceOptions);
    @overload
def AzureBlobFolder(resource_name: str,
                    args: AzureBlobFolderArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def AzureBlobFolder(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    container_name: Optional[str] = None,
                    path: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    storage_account_name: Optional[str] = None,
                    disable_managed_object_aliases: Optional[bool] = None,
                    include_hidden_files: Optional[bool] = None,
                    managed_objects: Optional[bool] = None)
    func NewAzureBlobFolder(ctx *Context, name string, args AzureBlobFolderArgs, opts ...ResourceOption) (*AzureBlobFolder, error)
    public AzureBlobFolder(string name, AzureBlobFolderArgs args, ComponentResourceOptions? opts = null)
    public AzureBlobFolder(String name, AzureBlobFolderArgs args)
public AzureBlobFolder(String name, AzureBlobFolderArgs args, ComponentResourceOptions options)

    type: synced-folder:AzureBlobFolder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AzureBlobFolderArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AzureBlobFolderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AzureBlobFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AzureBlobFolderArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AzureBlobFolderArgs
    The arguments to resource properties.
    options ComponentResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureBlobFolderResource = new SyncedFolder.AzureBlobFolder("azureBlobFolderResource", new()
{
    ContainerName = "string",
    Path = "string",
    ResourceGroupName = "string",
    StorageAccountName = "string",
    DisableManagedObjectAliases = false,
    IncludeHiddenFiles = false,
    ManagedObjects = false,
});

    example, err := syncedfolder.NewAzureBlobFolder(ctx, "azureBlobFolderResource", &syncedfolder.AzureBlobFolderArgs{
	ContainerName:               pulumi.String("string"),
	Path:                        pulumi.String("string"),
	ResourceGroupName:           pulumi.String("string"),
	StorageAccountName:          pulumi.String("string"),
	DisableManagedObjectAliases: pulumi.Bool(false),
	IncludeHiddenFiles:          pulumi.Bool(false),
	ManagedObjects:              pulumi.Bool(false),
})

    var azureBlobFolderResource = new AzureBlobFolder("azureBlobFolderResource", AzureBlobFolderArgs.builder()
    .containerName("string")
    .path("string")
    .resourceGroupName("string")
    .storageAccountName("string")
    .disableManagedObjectAliases(false)
    .includeHiddenFiles(false)
    .managedObjects(false)
    .build());

    azure_blob_folder_resource = synced_folder.AzureBlobFolder("azureBlobFolderResource",
    container_name="string",
    path="string",
    resource_group_name="string",
    storage_account_name="string",
    disable_managed_object_aliases=False,
    include_hidden_files=False,
    managed_objects=False)

    const azureBlobFolderResource = new synced_folder.AzureBlobFolder("azureBlobFolderResource", {
    containerName: "string",
    path: "string",
    resourceGroupName: "string",
    storageAccountName: "string",
    disableManagedObjectAliases: false,
    includeHiddenFiles: false,
    managedObjects: false,
});

    type: synced-folder:AzureBlobFolder
properties:
    containerName: string
    disableManagedObjectAliases: false
    includeHiddenFiles: false
    managedObjects: false
    path: string
    resourceGroupName: string
    storageAccountName: string

    AzureBlobFolder 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 AzureBlobFolder resource accepts the following input properties:

    ContainerName string
    The name of the Azure storage container to sync to. Required.
    Path string
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    ResourceGroupName string
    The name of the Azure resource group that the storage account belongs to. Required.
    StorageAccountName string
    The name of the Azure storage account that the container belongs to. Required.
    DisableManagedObjectAliases bool
    Disables adding an alias resource option to managed objects in the bucket.
    IncludeHiddenFiles bool
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    ManagedObjects bool
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    ContainerName string
    The name of the Azure storage container to sync to. Required.
    Path string
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    ResourceGroupName string
    The name of the Azure resource group that the storage account belongs to. Required.
    StorageAccountName string
    The name of the Azure storage account that the container belongs to. Required.
    DisableManagedObjectAliases bool
    Disables adding an alias resource option to managed objects in the bucket.
    IncludeHiddenFiles bool
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    ManagedObjects bool
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    containerName String
    The name of the Azure storage container to sync to. Required.
    path String
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    resourceGroupName String
    The name of the Azure resource group that the storage account belongs to. Required.
    storageAccountName String
    The name of the Azure storage account that the container belongs to. Required.
    disableManagedObjectAliases Boolean
    Disables adding an alias resource option to managed objects in the bucket.
    includeHiddenFiles Boolean
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    managedObjects Boolean
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    containerName string
    The name of the Azure storage container to sync to. Required.
    path string
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    resourceGroupName string
    The name of the Azure resource group that the storage account belongs to. Required.
    storageAccountName string
    The name of the Azure storage account that the container belongs to. Required.
    disableManagedObjectAliases boolean
    Disables adding an alias resource option to managed objects in the bucket.
    includeHiddenFiles boolean
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    managedObjects boolean
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    container_name str
    The name of the Azure storage container to sync to. Required.
    path str
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    resource_group_name str
    The name of the Azure resource group that the storage account belongs to. Required.
    storage_account_name str
    The name of the Azure storage account that the container belongs to. Required.
    disable_managed_object_aliases bool
    Disables adding an alias resource option to managed objects in the bucket.
    include_hidden_files bool
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    managed_objects bool
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.
    containerName String
    The name of the Azure storage container to sync to. Required.
    path String
    The path (relative or fully-qualified) to the folder containing the files to be synced. Required.
    resourceGroupName String
    The name of the Azure resource group that the storage account belongs to. Required.
    storageAccountName String
    The name of the Azure storage account that the container belongs to. Required.
    disableManagedObjectAliases Boolean
    Disables adding an alias resource option to managed objects in the bucket.
    includeHiddenFiles Boolean
    Include hidden files ("dotfiles") when synchronizing folders. Defaults to false.
    managedObjects Boolean
    Whether to have Pulumi manage files as individual cloud resources. Defaults to true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AzureBlobFolder resource produces the following output properties:

    Package Details

    Repository
    synced-folder pulumi/pulumi-synced-folder
    License
    synced-folder logo
    Synced Folder v0.11.1 published on Wednesday, Aug 2, 2023 by Pulumi
    pulumi/pulumi-synced-folder