This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

datashare¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.datashare.Account(resource_name, opts=None, identity=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Data Share Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.datashare.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    identity={
        "type": "SystemAssigned",
    },
    tags={
        "foo": "bar",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
identity (pulumi.Input[dict]) – An identity block as defined below.
location (pulumi.Input[str]) – The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name (pulumi.Input[str]) – The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
tags (pulumi.Input[dict]) – A mapping of tags which should be assigned to the Data Share Account.

The identity object supports the following:

principal_id (pulumi.Input[str]) - The Principal ID for the Service Principal associated with the Identity of this Data Share Account.
tenant_id (pulumi.Input[str]) - The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.
type (pulumi.Input[str]) - Specifies the identity type of the Data Share Account. At this time the only allowed value is SystemAssigned.

identity: pulumi.Output[dict] = None¶

An identity block as defined below.

principal_id (str) - The Principal ID for the Service Principal associated with the Identity of this Data Share Account.
tenant_id (str) - The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.
type (str) - Specifies the identity type of the Data Share Account. At this time the only allowed value is SystemAssigned.

location: pulumi.Output[str] = None¶: The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.

name: pulumi.Output[str] = None¶: The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the Resource Group where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags which should be assigned to the Data Share Account.

static get(resource_name, id, opts=None, identity=None, location=None, name=None, resource_group_name=None, tags=None)¶

Get an existing Account resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
identity (pulumi.Input[dict]) – An identity block as defined below.
location (pulumi.Input[str]) – The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name (pulumi.Input[str]) – The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
tags (pulumi.Input[dict]) – A mapping of tags which should be assigned to the Data Share Account.

The identity object supports the following:

principal_id (pulumi.Input[str]) - The Principal ID for the Service Principal associated with the Identity of this Data Share Account.
tenant_id (pulumi.Input[str]) - The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.
type (pulumi.Input[str]) - Specifies the identity type of the Data Share Account. At this time the only allowed value is SystemAssigned.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datashare.AwaitableGetAccountResult(id=None, identities=None, name=None, resource_group_name=None, tags=None)¶

class pulumi_azure.datashare.AwaitableGetDatasetBlobStorageResult(container_name=None, data_share_id=None, display_name=None, file_path=None, folder_path=None, id=None, name=None, storage_accounts=None)¶

class pulumi_azure.datashare.AwaitableGetShareResult(account_id=None, description=None, id=None, kind=None, name=None, snapshot_schedules=None, terms=None)¶

class pulumi_azure.datashare.DatasetBlobStorage(resource_name, opts=None, container_name=None, data_share_id=None, file_path=None, folder_path=None, name=None, storage_account=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Data Share Blob Storage Dataset.

import pulumi
import pulumi_azure as azure
import pulumi_azuread as azuread

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.datashare.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    identity={
        "type": "SystemAssigned",
    })
example_share = azure.datashare.Share("exampleShare",
    account_id=example_account.id,
    kind="CopyBased")
example_storage_account_account = azure.storage.Account("exampleStorage/accountAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="RAGRS")
example_container = azure.storage.Container("exampleContainer",
    storage_account_name=example_storage / account_account["name"],
    container_access_type="container")
example_service_principal = example_account.name.apply(lambda name: azuread.get_service_principal(display_name=name))
example_assignment = azure.authorization.Assignment("exampleAssignment",
    scope=example_storage / account_account["id"],
    role_definition_name="Storage Blob Data Reader",
    principal_id=example_service_principal.object_id)
example_dataset_blob_storage = azure.datashare.DatasetBlobStorage("exampleDatasetBlobStorage",
    data_share_id=example_share.id,
    container_name=example_container.name,
    storage_account={
        "name": example_storage / account_account["name"],
        "resource_group_name": example_storage / account_account["resourceGroupName"],
        "subscription_id": "00000000-0000-0000-0000-000000000000",
    },
    file_path="myfile.txt")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
container_name (pulumi.Input[str]) – The name of the storage account container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
data_share_id (pulumi.Input[str]) – The ID of the Data Share in which this Data Share Blob Storage Dataset should be created. Changing this forces a new Data Share Blob Storage Dataset to be created.
file_path (pulumi.Input[str]) – The path of the file in the storage container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
folder_path (pulumi.Input[str]) – The path of the folder in the storage container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
name (pulumi.Input[str]) – The name which should be used for this Data Share Blob Storage Dataset. Changing this forces a new Data Share Blob Storage Dataset to be created.
storage_account (pulumi.Input[dict]) – A storage_account block as defined below.

The storage_account object supports the following:

name (pulumi.Input[str]) - The name of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
resource_group_name (pulumi.Input[str]) - The resource group name of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
subscription_id (pulumi.Input[str]) - The subscription id of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.

container_name: pulumi.Output[str] = None¶: The name of the storage account container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.

data_share_id: pulumi.Output[str] = None¶: The ID of the Data Share in which this Data Share Blob Storage Dataset should be created. Changing this forces a new Data Share Blob Storage Dataset to be created.

display_name: pulumi.Output[str] = None¶: The name of the Data Share Dataset.

file_path: pulumi.Output[str] = None¶: The path of the file in the storage container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.

folder_path: pulumi.Output[str] = None¶: The path of the folder in the storage container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.

name: pulumi.Output[str] = None¶: The name which should be used for this Data Share Blob Storage Dataset. Changing this forces a new Data Share Blob Storage Dataset to be created.

storage_account: pulumi.Output[dict] = None¶

A storage_account block as defined below.

name (str) - The name of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
resource_group_name (str) - The resource group name of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
subscription_id (str) - The subscription id of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.

static get(resource_name, id, opts=None, container_name=None, data_share_id=None, display_name=None, file_path=None, folder_path=None, name=None, storage_account=None)¶

Get an existing DatasetBlobStorage resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
container_name (pulumi.Input[str]) – The name of the storage account container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
data_share_id (pulumi.Input[str]) – The ID of the Data Share in which this Data Share Blob Storage Dataset should be created. Changing this forces a new Data Share Blob Storage Dataset to be created.
display_name (pulumi.Input[str]) – The name of the Data Share Dataset.
file_path (pulumi.Input[str]) – The path of the file in the storage container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
folder_path (pulumi.Input[str]) – The path of the folder in the storage container to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
name (pulumi.Input[str]) – The name which should be used for this Data Share Blob Storage Dataset. Changing this forces a new Data Share Blob Storage Dataset to be created.
storage_account (pulumi.Input[dict]) – A storage_account block as defined below.

The storage_account object supports the following:

name (pulumi.Input[str]) - The name of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
resource_group_name (pulumi.Input[str]) - The resource group name of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.
subscription_id (pulumi.Input[str]) - The subscription id of the storage account to be shared with the receiver. Changing this forces a new Data Share Blob Storage Dataset to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datashare.GetAccountResult(id=None, identities=None, name=None, resource_group_name=None, tags=None)¶

A collection of values returned by getAccount.

id = None¶: The provider-assigned unique ID for this managed resource.

identities = None¶: An identity block as defined below.

tags = None¶: A mapping of tags assigned to the Data Share Account.

class pulumi_azure.datashare.GetDatasetBlobStorageResult(container_name=None, data_share_id=None, display_name=None, file_path=None, folder_path=None, id=None, name=None, storage_accounts=None)¶

A collection of values returned by getDatasetBlobStorage.

container_name = None¶: The name of the storage account container to be shared with the receiver.

display_name = None¶: The name of the Data Share Dataset.

file_path = None¶: The path of the file in the storage container to be shared with the receiver.

folder_path = None¶: The folder path of the file in the storage container to be shared with the receiver.

id = None¶: The provider-assigned unique ID for this managed resource.

name = None¶: The name of the storage account to be shared with the receiver.

storage_accounts = None¶: A storage_account block as defined below.

class pulumi_azure.datashare.GetShareResult(account_id=None, description=None, id=None, kind=None, name=None, snapshot_schedules=None, terms=None)¶

A collection of values returned by getShare.

description = None¶: The description of the Data Share.

id = None¶: The provider-assigned unique ID for this managed resource.

kind = None¶: The kind of the Data Share.

name = None¶: The name of the snapshot schedule.

snapshot_schedules = None¶: A snapshot_schedule block as defined below.

terms = None¶: The terms of the Data Share.

class pulumi_azure.datashare.Share(resource_name, opts=None, account_id=None, description=None, kind=None, name=None, snapshot_schedule=None, terms=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Data Share.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.datashare.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tags={
        "foo": "bar",
    })
example_share = azure.datashare.Share("exampleShare",
    account_id=example_account.id,
    kind="CopyBased",
    description="example desc",
    terms="example terms",
    snapshot_schedule={
        "name": "example-ss",
        "recurrence": "Day",
        "start_time": "2020-04-17T04:47:52.9614956Z",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
account_id (pulumi.Input[str]) – The ID of the Data Share account in which the Data Share is created. Changing this forces a new Data Share to be created.
description (pulumi.Input[str]) – The Data Share’s description.
kind (pulumi.Input[str]) – The kind of the Data Share. Possible values are CopyBased and InPlace. Changing this forces a new Data Share to be created.
name (pulumi.Input[str]) – The name which should be used for this Data Share. Changing this forces a new Data Share to be created.
snapshot_schedule (pulumi.Input[dict]) – A snapshot_schedule block as defined below.
terms (pulumi.Input[str]) – The terms of the Data Share.

The snapshot_schedule object supports the following:

name (pulumi.Input[str]) - The name of the snapshot schedule.
recurrence (pulumi.Input[str]) - The interval of the synchronization with the source data. Possible values are Hour and Day.
start_time (pulumi.Input[str]) - The synchronization with the source data’s start time.

account_id: pulumi.Output[str] = None¶: The ID of the Data Share account in which the Data Share is created. Changing this forces a new Data Share to be created.

description: pulumi.Output[str] = None¶: The Data Share’s description.

kind: pulumi.Output[str] = None¶: The kind of the Data Share. Possible values are CopyBased and InPlace. Changing this forces a new Data Share to be created.

name: pulumi.Output[str] = None¶: The name which should be used for this Data Share. Changing this forces a new Data Share to be created.

snapshot_schedule: pulumi.Output[dict] = None¶

A snapshot_schedule block as defined below.

name (str) - The name of the snapshot schedule.
recurrence (str) - The interval of the synchronization with the source data. Possible values are Hour and Day.
start_time (str) - The synchronization with the source data’s start time.

terms: pulumi.Output[str] = None¶: The terms of the Data Share.

static get(resource_name, id, opts=None, account_id=None, description=None, kind=None, name=None, snapshot_schedule=None, terms=None)¶

Get an existing Share resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_id (pulumi.Input[str]) – The ID of the Data Share account in which the Data Share is created. Changing this forces a new Data Share to be created.
description (pulumi.Input[str]) – The Data Share’s description.
kind (pulumi.Input[str]) – The kind of the Data Share. Possible values are CopyBased and InPlace. Changing this forces a new Data Share to be created.
name (pulumi.Input[str]) – The name which should be used for this Data Share. Changing this forces a new Data Share to be created.
snapshot_schedule (pulumi.Input[dict]) – A snapshot_schedule block as defined below.
terms (pulumi.Input[str]) – The terms of the Data Share.

The snapshot_schedule object supports the following:

name (pulumi.Input[str]) - The name of the snapshot schedule.
recurrence (pulumi.Input[str]) - The interval of the synchronization with the source data. Possible values are Hour and Day.
start_time (pulumi.Input[str]) - The synchronization with the source data’s start time.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.datashare.get_account(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Data Share Account.

import pulumi
import pulumi_azure as azure

example = azure.datashare.get_account(name="example-account",
    resource_group_name="example-resource-group")
pulumi.export("id", example.id)

Parameters

name (str) – The name of this Data Share Account.
resource_group_name (str) – The name of the Resource Group where the Data Share Account exists.

pulumi_azure.datashare.get_dataset_blob_storage(data_share_id=None, name=None, opts=None)¶

Use this data source to access information about an existing Data Share Blob Storage Dataset.

import pulumi
import pulumi_azure as azure

example = azure.datashare.get_dataset_blob_storage(name="example-dsbsds",
    data_share_id="example-share-id")
pulumi.export("id", example.id)

Parameters

data_share_id (str) – The ID of the Data Share in which this Data Share Blob Storage Dataset should be created.
name (str) – The name of this Data Share Blob Storage Dataset.

pulumi_azure.datashare.get_share(account_id=None, name=None, opts=None)¶

Use this data source to access information about an existing Data Share.

import pulumi
import pulumi_azure as azure

example_account = azure.datashare.get_account(name="example-account",
    resource_group_name="example-resource-group")
example_share = azure.datashare.get_share(name="existing",
    account_id=data["azurerm_data_share_account"]["exmaple"]["id"])
pulumi.export("id", example_share.id)

Parameters

account_id (str) – The ID of the Data Share account in which the Data Share is created.
name (str) – The name of this Data Share.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

datashare¶

On This Page