Module datalake

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 AnalyticsAccount

class AnalyticsAccount extends CustomResource

Manages an Azure Data Lake Analytics Account.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleStore = new azure.datalake.Store("exampleStore", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleAnalyticsAccount = new azure.datalake.AnalyticsAccount("exampleAnalyticsAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    defaultStoreAccountName: exampleStore.name,
});

constructor

new AnalyticsAccount(name: string, args: AnalyticsAccountArgs, opts?: pulumi.CustomResourceOptions)

Create a AnalyticsAccount 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?: AnalyticsAccountState, opts?: pulumi.CustomResourceOptions): AnalyticsAccount

Get an existing AnalyticsAccount 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 AnalyticsAccount

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

property defaultStoreAccountName

public defaultStoreAccountName: pulumi.Output<string>;

Specifies the data lake store to use by default. Changing this forces a new resource to be created.

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 location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Data Lake Analytics Account. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Data Lake Analytics Account.

property tags

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

A mapping of tags to assign to the resource.

property tier

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

The monthly commitment tier for Data Lake Analytics Account. Accepted values are Consumption, Commitment_100000AUHours, Commitment_10000AUHours, Commitment_1000AUHours, Commitment_100AUHours, Commitment_500000AUHours, Commitment_50000AUHours, Commitment_5000AUHours, or Commitment_500AUHours.

property urn

urn: Output<URN>;

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

Resource AnalyticsFirewallRule

class AnalyticsFirewallRule extends CustomResource

Manages a Azure Data Lake Analytics Firewall Rule.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleStore = new azure.datalake.Store("exampleStore", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleAnalyticsAccount = new azure.datalake.AnalyticsAccount("exampleAnalyticsAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    defaultStoreAccountName: exampleStore.name,
});
const exampleAnalyticsFirewallRule = new azure.datalake.AnalyticsFirewallRule("exampleAnalyticsFirewallRule", {
    accountName: azurerm_data_lake_analytics.example.name,
    resourceGroupName: exampleResourceGroup.name,
    startIpAddress: "1.2.3.4",
    endIpAddress: "2.3.4.5",
});

constructor

new AnalyticsFirewallRule(name: string, args: AnalyticsFirewallRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a AnalyticsFirewallRule 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?: AnalyticsFirewallRuleState, opts?: pulumi.CustomResourceOptions): AnalyticsFirewallRule

Get an existing AnalyticsFirewallRule 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 AnalyticsFirewallRule

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

property accountName

public accountName: pulumi.Output<string>;

Specifies the name of the Data Lake Analytics for which the Firewall Rule should take effect.

property endIpAddress

public endIpAddress: pulumi.Output<string>;

The End IP Address for the firewall rule.

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 name

public name: pulumi.Output<string>;

Specifies the name of the Data Lake Analytics. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Data Lake Analytics.

property startIpAddress

public startIpAddress: pulumi.Output<string>;

The Start IP address for the firewall rule.

property urn

urn: Output<URN>;

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

Resource Store

class Store extends CustomResource

Manages an Azure Data Lake Store.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleStore = new azure.datalake.Store("exampleStore", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    encryptionState: "Enabled",
    encryptionType: "ServiceManaged",
});

constructor

new Store(name: string, args: StoreArgs, opts?: pulumi.CustomResourceOptions)

Create a Store 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?: StoreState, opts?: pulumi.CustomResourceOptions): Store

Get an existing Store 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 Store

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

property encryptionState

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

Is Encryption enabled on this Data Lake Store Account? Possible values are Enabled or Disabled. Defaults to Enabled.

property encryptionType

public encryptionType: pulumi.Output<string>;

The Encryption Type used for this Data Lake Store Account. Currently can be set to ServiceManaged when encryptionState is Enabled - and must be a blank string when it’s Disabled.

property endpoint

public endpoint: pulumi.Output<string>;

The Endpoint for the Data Lake Store.

property firewallAllowAzureIps

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

are Azure Service IP’s allowed through the firewall? Possible values are Enabled and Disabled. Defaults to Enabled.

property firewallState

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

the state of the Firewall. Possible values are Enabled and Disabled. Defaults to Enabled.

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 location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Data Lake Store.

property tags

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

A mapping of tags to assign to the resource.

property tier

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

The monthly commitment tier for Data Lake Store. Accepted values are Consumption, Commitment_1TB, Commitment_10TB, Commitment_100TB, Commitment_500TB, Commitment_1PB or Commitment_5PB.

property urn

urn: Output<URN>;

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

Resource StoreFile

class StoreFile extends CustomResource

Manages a Azure Data Lake Store File.

Note: If you want to change the data in the remote file without changing the localFilePath, then taint the resource so the azure.datalake.StoreFile gets recreated with the new data.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleStore = new azure.datalake.Store("exampleStore", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleStoreFile = new azure.datalake.StoreFile("exampleStoreFile", {
    resourceGroupName: exampleResourceGroup.name,
    localFilePath: "/path/to/local/file",
    remoteFilePath: "/path/created/for/remote/file",
});

constructor

new StoreFile(name: string, args: StoreFileArgs, opts?: pulumi.CustomResourceOptions)

Create a StoreFile 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?: StoreFileState, opts?: pulumi.CustomResourceOptions): StoreFile

Get an existing StoreFile 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 StoreFile

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

property accountName

public accountName: pulumi.Output<string>;

Specifies the name of the Data Lake Store for which the File should created.

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 localFilePath

public localFilePath: pulumi.Output<string>;

The path to the local file to be added to the Data Lake Store.

property remoteFilePath

public remoteFilePath: pulumi.Output<string>;

The path created for the file on the Data Lake Store.

property urn

urn: Output<URN>;

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

Resource StoreFirewallRule

class StoreFirewallRule extends CustomResource

Manages a Azure Data Lake Store Firewall Rule.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleStore = new azure.datalake.Store("exampleStore", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleStoreFirewallRule = new azure.datalake.StoreFirewallRule("exampleStoreFirewallRule", {
    accountName: exampleStore.name,
    resourceGroupName: exampleResourceGroup.name,
    startIpAddress: "1.2.3.4",
    endIpAddress: "2.3.4.5",
});

constructor

new StoreFirewallRule(name: string, args: StoreFirewallRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a StoreFirewallRule 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?: StoreFirewallRuleState, opts?: pulumi.CustomResourceOptions): StoreFirewallRule

Get an existing StoreFirewallRule 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 StoreFirewallRule

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

property accountName

public accountName: pulumi.Output<string>;

Specifies the name of the Data Lake Store for which the Firewall Rule should take effect.

property endIpAddress

public endIpAddress: pulumi.Output<string>;

The End IP Address for the firewall rule.

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 name

public name: pulumi.Output<string>;

Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Data Lake Store.

property startIpAddress

public startIpAddress: pulumi.Output<string>;

The Start IP address for the firewall rule.

property urn

urn: Output<URN>;

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

Functions

Function getStore

getStore(args: GetStoreArgs, opts?: pulumi.InvokeOptions): Promise<GetStoreResult>

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

Example Usage

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

const example = azure.datalake.getStore({
    name: "testdatalake",
    resourceGroupName: "testdatalake",
});
export const dataLakeStoreId = example.then(example => example.id);

Others

interface AnalyticsAccountArgs

interface AnalyticsAccountArgs

The set of arguments for constructing a AnalyticsAccount resource.

property defaultStoreAccountName

defaultStoreAccountName: pulumi.Input<string>;

Specifies the data lake store to use by default. Changing this forces a new resource to be created.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Data Lake Analytics Account. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Data Lake Analytics Account.

property tags

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

A mapping of tags to assign to the resource.

property tier

tier?: pulumi.Input<string>;

interface AnalyticsAccountState

interface AnalyticsAccountState

Input properties used for looking up and filtering AnalyticsAccount resources.

property defaultStoreAccountName

defaultStoreAccountName?: pulumi.Input<string>;

Specifies the data lake store to use by default. Changing this forces a new resource to be created.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Data Lake Analytics Account. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Data Lake Analytics Account.

property tags

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

A mapping of tags to assign to the resource.

property tier

tier?: pulumi.Input<string>;

interface AnalyticsFirewallRuleArgs

interface AnalyticsFirewallRuleArgs

The set of arguments for constructing a AnalyticsFirewallRule resource.

property accountName

accountName: pulumi.Input<string>;

Specifies the name of the Data Lake Analytics for which the Firewall Rule should take effect.

property endIpAddress

endIpAddress: pulumi.Input<string>;

The End IP Address for the firewall rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the Data Lake Analytics. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Data Lake Analytics.

property startIpAddress

startIpAddress: pulumi.Input<string>;

The Start IP address for the firewall rule.

interface AnalyticsFirewallRuleState

interface AnalyticsFirewallRuleState

Input properties used for looking up and filtering AnalyticsFirewallRule resources.

property accountName

accountName?: pulumi.Input<string>;

Specifies the name of the Data Lake Analytics for which the Firewall Rule should take effect.

property endIpAddress

endIpAddress?: pulumi.Input<string>;

The End IP Address for the firewall rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the Data Lake Analytics. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Data Lake Analytics.

property startIpAddress

startIpAddress?: pulumi.Input<string>;

The Start IP address for the firewall rule.

interface GetStoreArgs

interface GetStoreArgs

A collection of arguments for invoking getStore.

property name

name: string;

The name of the Data Lake Store.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the Data Lake Store exists.

interface GetStoreResult

interface GetStoreResult

A collection of values returned by getStore.

property encryptionState

encryptionState: string;

the Encryption State of this Data Lake Store Account, such as Enabled or Disabled.

property encryptionType

encryptionType: string;

the Encryption Type used for this Data Lake Store Account.

property firewallAllowAzureIps

firewallAllowAzureIps: string;

are Azure Service IP’s allowed through the firewall?

property firewallState

firewallState: string;

the state of the firewall, such as Enabled or Disabled.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

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

A mapping of tags to assign to the Data Lake Store.

property tier

tier: string;

Current monthly commitment tier for the account.

interface StoreArgs

interface StoreArgs

The set of arguments for constructing a Store resource.

property encryptionState

encryptionState?: pulumi.Input<string>;

Is Encryption enabled on this Data Lake Store Account? Possible values are Enabled or Disabled. Defaults to Enabled.

property encryptionType

encryptionType?: pulumi.Input<string>;

The Encryption Type used for this Data Lake Store Account. Currently can be set to ServiceManaged when encryptionState is Enabled - and must be a blank string when it’s Disabled.

property firewallAllowAzureIps

firewallAllowAzureIps?: pulumi.Input<string>;

are Azure Service IP’s allowed through the firewall? Possible values are Enabled and Disabled. Defaults to Enabled.

property firewallState

firewallState?: pulumi.Input<string>;

the state of the Firewall. Possible values are Enabled and Disabled. Defaults to Enabled.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Data Lake Store.

property tags

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

A mapping of tags to assign to the resource.

property tier

tier?: pulumi.Input<string>;

The monthly commitment tier for Data Lake Store. Accepted values are Consumption, Commitment_1TB, Commitment_10TB, Commitment_100TB, Commitment_500TB, Commitment_1PB or Commitment_5PB.

interface StoreFileArgs

interface StoreFileArgs

The set of arguments for constructing a StoreFile resource.

property accountName

accountName: pulumi.Input<string>;

Specifies the name of the Data Lake Store for which the File should created.

property localFilePath

localFilePath: pulumi.Input<string>;

The path to the local file to be added to the Data Lake Store.

property remoteFilePath

remoteFilePath: pulumi.Input<string>;

The path created for the file on the Data Lake Store.

interface StoreFileState

interface StoreFileState

Input properties used for looking up and filtering StoreFile resources.

property accountName

accountName?: pulumi.Input<string>;

Specifies the name of the Data Lake Store for which the File should created.

property localFilePath

localFilePath?: pulumi.Input<string>;

The path to the local file to be added to the Data Lake Store.

property remoteFilePath

remoteFilePath?: pulumi.Input<string>;

The path created for the file on the Data Lake Store.

interface StoreFirewallRuleArgs

interface StoreFirewallRuleArgs

The set of arguments for constructing a StoreFirewallRule resource.

property accountName

accountName: pulumi.Input<string>;

Specifies the name of the Data Lake Store for which the Firewall Rule should take effect.

property endIpAddress

endIpAddress: pulumi.Input<string>;

The End IP Address for the firewall rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Data Lake Store.

property startIpAddress

startIpAddress: pulumi.Input<string>;

The Start IP address for the firewall rule.

interface StoreFirewallRuleState

interface StoreFirewallRuleState

Input properties used for looking up and filtering StoreFirewallRule resources.

property accountName

accountName?: pulumi.Input<string>;

Specifies the name of the Data Lake Store for which the Firewall Rule should take effect.

property endIpAddress

endIpAddress?: pulumi.Input<string>;

The End IP Address for the firewall rule.

property name

name?: pulumi.Input<string>;

Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Data Lake Store.

property startIpAddress

startIpAddress?: pulumi.Input<string>;

The Start IP address for the firewall rule.

interface StoreState

interface StoreState

Input properties used for looking up and filtering Store resources.

property encryptionState

encryptionState?: pulumi.Input<string>;

Is Encryption enabled on this Data Lake Store Account? Possible values are Enabled or Disabled. Defaults to Enabled.

property encryptionType

encryptionType?: pulumi.Input<string>;

The Encryption Type used for this Data Lake Store Account. Currently can be set to ServiceManaged when encryptionState is Enabled - and must be a blank string when it’s Disabled.

property endpoint

endpoint?: pulumi.Input<string>;

The Endpoint for the Data Lake Store.

property firewallAllowAzureIps

firewallAllowAzureIps?: pulumi.Input<string>;

are Azure Service IP’s allowed through the firewall? Possible values are Enabled and Disabled. Defaults to Enabled.

property firewallState

firewallState?: pulumi.Input<string>;

the state of the Firewall. Possible values are Enabled and Disabled. Defaults to Enabled.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Data Lake Store.

property tags

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

A mapping of tags to assign to the resource.

property tier

tier?: pulumi.Input<string>;

The monthly commitment tier for Data Lake Store. Accepted values are Consumption, Commitment_1TB, Commitment_10TB, Commitment_100TB, Commitment_500TB, Commitment_1PB or Commitment_5PB.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module datalake

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Functions

Example Usage

Others