Module datashare

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.

Resources

Resource Account

class Account extends CustomResource

Manages a Data Share Account.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.datashare.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    identity: {
        type: "SystemAssigned",
    },
    tags: {
        foo: "bar",
    },
});

constructor

new Account(name: string, args: AccountArgs, opts?: pulumi.CustomResourceOptions)

Create a Account resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountState, opts?: pulumi.CustomResourceOptions): Account

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Account

Returns true if the given object is an instance of Account. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<AccountIdentity>;

An identity block as defined below.

property location

public location: pulumi.Output<string>;

The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.

property name

public name: pulumi.Output<string>;

The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<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.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags which should be assigned to the Data Share Account.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Share extends CustomResource

Manages a Data Share.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.datashare.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tags: {
        foo: "bar",
    },
});
const exampleShare = new azure.datashare.Share("exampleShare", {
    accountId: exampleAccount.id,
    kind: "CopyBased",
    description: "example desc",
    terms: "example terms",
    snapshot_schedule: {
        name: "example-ss",
        recurrence: "Day",
        startTime: "2020-04-17T04:47:52.9614956Z",
    },
});

new Share(name: string, args: ShareArgs, opts?: pulumi.CustomResourceOptions)

Create a Share resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ShareState, opts?: pulumi.CustomResourceOptions): Share

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

getProvider(moduleMember: string): ProviderResource | undefined

public static isInstance(obj: any): obj is Share

Returns true if the given object is an instance of Share. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

public accountId: pulumi.Output<string>;

The ID of the Data Share account in which the Data Share is created. Changing this forces a new Data Share to be created.

public description: pulumi.Output<string | undefined>;

The Data Share’s description.

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

public kind: pulumi.Output<string>;

The kind of the Data Share. Possible values are CopyBased and InPlace. Changing this forces a new Data Share to be created.

public name: pulumi.Output<string>;

The name which should be used for this Data Share. Changing this forces a new Data Share to be created.

public snapshotSchedule: pulumi.Output<ShareSnapshotSchedule | undefined>;

A snapshotSchedule block as defined below.

public terms: pulumi.Output<string | undefined>;

The terms of the Data Share.

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getAccount

getAccount(args: GetAccountArgs, opts?: pulumi.InvokeOptions): Promise<GetAccountResult>

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

Example Usage

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

const example = azure.datashare.getAccount({
    name: "example-account",
    resourceGroupName: "example-resource-group",
});
export const id = example.then(example => example.id);

Function getShare

getShare(args: GetShareArgs, opts?: pulumi.InvokeOptions): Promise<GetShareResult>

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

Example Usage

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

const exampleAccount = azure.datashare.getAccount({
    name: "example-account",
    resourceGroupName: "example-resource-group",
});
const exampleShare = azure.datashare.getShare({
    name: "existing",
    accountId: data.azurerm_data_share_account.exmaple.id,
});
export const id = exampleShare.then(exampleShare => exampleShare.id);

Others

interface AccountArgs

interface AccountArgs

The set of arguments for constructing a Account resource.

property identity

identity: pulumi.Input<AccountIdentity>;

An identity block as defined below.

property location

location?: pulumi.Input<string>;

The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.

property name

name?: pulumi.Input<string>;

The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags which should be assigned to the Data Share Account.

interface AccountState

interface AccountState

Input properties used for looking up and filtering Account resources.

property identity

identity?: pulumi.Input<AccountIdentity>;

An identity block as defined below.

property location

location?: pulumi.Input<string>;

The Azure Region where the Data Share Account should exist. Changing this forces a new Data Share Account to be created.

property name

name?: pulumi.Input<string>;

The name which should be used for this Data Share Account. Changing this forces a new Data Share Account to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags which should be assigned to the Data Share Account.

interface GetAccountArgs

interface GetAccountArgs

A collection of arguments for invoking getAccount.

property name

name: string;

The name of this Data Share Account.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group where the Data Share Account exists.

interface GetAccountResult

interface GetAccountResult

A collection of values returned by getAccount.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property identities

identities: GetAccountIdentity[];

An identity block as defined below.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the Data Share Account.

interface GetShareArgs

interface GetShareArgs

A collection of arguments for invoking getShare.

property accountId

accountId: string;

The ID of the Data Share account in which the Data Share is created.

property name

name: string;

The name of this Data Share.

interface GetShareResult

interface GetShareResult

A collection of values returned by getShare.

property accountId

accountId: string;

property description

description: string;

The description of the Data Share.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kind

kind: string;

The kind of the Data Share.

property name

name: string;

The name of the snapshot schedule.

property snapshotSchedules

snapshotSchedules: GetShareSnapshotSchedule[];

A snapshotSchedule block as defined below.

property terms

terms: string;

The terms of the Data Share.

interface ShareArgs

interface ShareArgs

The set of arguments for constructing a Share resource.

property accountId

accountId: pulumi.Input<string>;

The ID of the Data Share account in which the Data Share is created. Changing this forces a new Data Share to be created.

property description

description?: pulumi.Input<string>;

The Data Share’s description.

property kind

kind: pulumi.Input<string>;

The kind of the Data Share. Possible values are CopyBased and InPlace. Changing this forces a new Data Share to be created.

property name

name?: pulumi.Input<string>;

The name which should be used for this Data Share. Changing this forces a new Data Share to be created.

property snapshotSchedule

snapshotSchedule?: pulumi.Input<ShareSnapshotSchedule>;

A snapshotSchedule block as defined below.

property terms

terms?: pulumi.Input<string>;

The terms of the Data Share.

interface ShareState

interface ShareState

Input properties used for looking up and filtering Share resources.

property accountId

accountId?: pulumi.Input<string>;

The ID of the Data Share account in which the Data Share is created. Changing this forces a new Data Share to be created.

property description

description?: pulumi.Input<string>;

The Data Share’s description.

property kind

kind?: pulumi.Input<string>;

The kind of the Data Share. Possible values are CopyBased and InPlace. Changing this forces a new Data Share to be created.

property name

name?: pulumi.Input<string>;

The name which should be used for this Data Share. Changing this forces a new Data Share to be created.

property snapshotSchedule

snapshotSchedule?: pulumi.Input<ShareSnapshotSchedule>;

A snapshotSchedule block as defined below.

property terms

terms?: pulumi.Input<string>;

The terms of the Data Share.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module datashare

Resources

Functions

Others

Resources

Example Usage

Example Usage

Functions

Example Usage

Example Usage

Others