1. Packages
  2. Azure Classic
  3. API Docs
  4. datashare
  5. Account

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.datashare.Account

Explore with Pulumi AI

Manages a Data Share Account.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccount = new azure.datashare.Account("example", {
    name: "example-dsa",
    location: example.location,
    resourceGroupName: example.name,
    identity: {
        type: "SystemAssigned",
    },
    tags: {
        foo: "bar",
    },
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.datashare.Account("example",
    name="example-dsa",
    location=example.location,
    resource_group_name=example.name,
    identity={
        "type": "SystemAssigned",
    },
    tags={
        "foo": "bar",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datashare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = datashare.NewAccount(ctx, "example", &datashare.AccountArgs{
			Name:              pulumi.String("example-dsa"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Identity: &datashare.AccountIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleAccount = new Azure.DataShare.Account("example", new()
    {
        Name = "example-dsa",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Identity = new Azure.DataShare.Inputs.AccountIdentityArgs
        {
            Type = "SystemAssigned",
        },
        Tags = 
        {
            { "foo", "bar" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.datashare.Account;
import com.pulumi.azure.datashare.AccountArgs;
import com.pulumi.azure.datashare.inputs.AccountIdentityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example-dsa")
            .location(example.location())
            .resourceGroupName(example.name())
            .identity(AccountIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .tags(Map.of("foo", "bar"))
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:datashare:Account
    name: example
    properties:
      name: example-dsa
      location: ${example.location}
      resourceGroupName: ${example.name}
      identity:
        type: SystemAssigned
      tags:
        foo: bar
Copy

Create Account Resource

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

Constructor syntax

new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
@overload
def Account(resource_name: str,
            args: AccountArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            identity: Optional[AccountIdentityArgs] = None,
            resource_group_name: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)
type: azure:datashare:Account
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. AccountArgs
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. AccountArgs
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. AccountArgs
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. AccountArgs
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. AccountArgs
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 exampleaccountResourceResourceFromDatashareaccount = new Azure.DataShare.Account("exampleaccountResourceResourceFromDatashareaccount", new()
{
    Identity = new Azure.DataShare.Inputs.AccountIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := datashare.NewAccount(ctx, "exampleaccountResourceResourceFromDatashareaccount", &datashare.AccountArgs{
	Identity: &datashare.AccountIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleaccountResourceResourceFromDatashareaccount = new Account("exampleaccountResourceResourceFromDatashareaccount", AccountArgs.builder()
    .identity(AccountIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
exampleaccount_resource_resource_from_datashareaccount = azure.datashare.Account("exampleaccountResourceResourceFromDatashareaccount",
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    resource_group_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const exampleaccountResourceResourceFromDatashareaccount = new azure.datashare.Account("exampleaccountResourceResourceFromDatashareaccount", {
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    resourceGroupName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:datashare:Account
properties:
    identity:
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
Copy

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

Identity
This property is required.
Changes to this property will trigger replacement.
AccountIdentity
An identity block as defined below. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Data Share Account.
Identity
This property is required.
Changes to this property will trigger replacement.
AccountIdentityArgs
An identity block as defined below. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
Tags map[string]string
A mapping of tags which should be assigned to the Data Share Account.
identity
This property is required.
Changes to this property will trigger replacement.
AccountIdentity
An identity block as defined below. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the Data Share Account.
identity
This property is required.
Changes to this property will trigger replacement.
AccountIdentity
An identity block as defined below. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
location Changes to this property will trigger replacement. string
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Data Share Account.
identity
This property is required.
Changes to this property will trigger replacement.
AccountIdentityArgs
An identity block as defined below. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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.
location Changes to this property will trigger replacement. str
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Data Share Account.
identity
This property is required.
Changes to this property will trigger replacement.
Property Map
An identity block as defined below. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
tags Map<String>
A mapping of tags which should be assigned to the Data Share Account.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Account Resource

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

public static get(name: string, id: Input<ID>, state?: AccountState, opts?: CustomResourceOptions): Account
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        identity: Optional[AccountIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Account
func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
public static Account get(String name, Output<String> id, AccountState state, CustomResourceOptions options)
resources:  _:    type: azure:datashare:Account    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Identity Changes to this property will trigger replacement. AccountIdentity
An identity block as defined below. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
ResourceGroupName Changes to this property will trigger replacement. string
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 Dictionary<string, string>
A mapping of tags which should be assigned to the Data Share Account.
Identity Changes to this property will trigger replacement. AccountIdentityArgs
An identity block as defined below. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
ResourceGroupName Changes to this property will trigger replacement. string
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 map[string]string
A mapping of tags which should be assigned to the Data Share Account.
identity Changes to this property will trigger replacement. AccountIdentity
An identity block as defined below. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
resourceGroupName Changes to this property will trigger replacement. String
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 Map<String,String>
A mapping of tags which should be assigned to the Data Share Account.
identity Changes to this property will trigger replacement. AccountIdentity
An identity block as defined below. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
resourceGroupName Changes to this property will trigger replacement. string
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 {[key: string]: string}
A mapping of tags which should be assigned to the Data Share Account.
identity Changes to this property will trigger replacement. AccountIdentityArgs
An identity block as defined below. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Mapping[str, str]
A mapping of tags which should be assigned to the Data Share Account.
identity Changes to this property will trigger replacement. Property Map
An identity block as defined below. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.
resourceGroupName Changes to this property will trigger replacement. String
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 Map<String>
A mapping of tags which should be assigned to the Data Share Account.

Supporting Types

AccountIdentity
, AccountIdentityArgs

Type
This property is required.
Changes to this property will trigger replacement.
string

Specifies the type of Managed Service Identity that should be configured on this Data Share Account. The only possible value is SystemAssigned. Changing this forces a new resource to be created.

NOTE: The assigned principal_id and tenant_id can be retrieved after the identity type has been set to SystemAssigned and the Data Share Account has been created. More details are available below.

PrincipalId string
The Principal ID for the Service Principal associated with the Identity of this Data Share Account.
TenantId string
The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.
Type
This property is required.
Changes to this property will trigger replacement.
string

Specifies the type of Managed Service Identity that should be configured on this Data Share Account. The only possible value is SystemAssigned. Changing this forces a new resource to be created.

NOTE: The assigned principal_id and tenant_id can be retrieved after the identity type has been set to SystemAssigned and the Data Share Account has been created. More details are available below.

PrincipalId string
The Principal ID for the Service Principal associated with the Identity of this Data Share Account.
TenantId string
The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.
type
This property is required.
Changes to this property will trigger replacement.
String

Specifies the type of Managed Service Identity that should be configured on this Data Share Account. The only possible value is SystemAssigned. Changing this forces a new resource to be created.

NOTE: The assigned principal_id and tenant_id can be retrieved after the identity type has been set to SystemAssigned and the Data Share Account has been created. More details are available below.

principalId String
The Principal ID for the Service Principal associated with the Identity of this Data Share Account.
tenantId String
The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.
type
This property is required.
Changes to this property will trigger replacement.
string

Specifies the type of Managed Service Identity that should be configured on this Data Share Account. The only possible value is SystemAssigned. Changing this forces a new resource to be created.

NOTE: The assigned principal_id and tenant_id can be retrieved after the identity type has been set to SystemAssigned and the Data Share Account has been created. More details are available below.

principalId string
The Principal ID for the Service Principal associated with the Identity of this Data Share Account.
tenantId string
The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.
type
This property is required.
Changes to this property will trigger replacement.
str

Specifies the type of Managed Service Identity that should be configured on this Data Share Account. The only possible value is SystemAssigned. Changing this forces a new resource to be created.

NOTE: The assigned principal_id and tenant_id can be retrieved after the identity type has been set to SystemAssigned and the Data Share Account has been created. More details are available 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
This property is required.
Changes to this property will trigger replacement.
String

Specifies the type of Managed Service Identity that should be configured on this Data Share Account. The only possible value is SystemAssigned. Changing this forces a new resource to be created.

NOTE: The assigned principal_id and tenant_id can be retrieved after the identity type has been set to SystemAssigned and the Data Share Account has been created. More details are available below.

principalId String
The Principal ID for the Service Principal associated with the Identity of this Data Share Account.
tenantId String
The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.

Import

Data Share Accounts can be imported using the resource id, e.g.

$ pulumi import azure:datashare/account:Account example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataShare/accounts/account1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.