1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. appconfiguration

Module appconfiguration

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

Functions

Others

Resources

Resource ConfigurationStore

class ConfigurationStore extends CustomResource

Manages an Azure App Configuration.

Example Usage

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

const rg = new azure.core.ResourceGroup("rg", {location: "West Europe"});
const appconf = new azure.appconfiguration.ConfigurationStore("appconf", {
    resourceGroupName: rg.name,
    location: rg.location,
});

constructor

new ConfigurationStore(name: string, args: ConfigurationStoreArgs, opts?: pulumi.CustomResourceOptions)

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

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

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

property endpoint

public endpoint: pulumi.Output<string>;

The URL of the App Configuration.

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 App Configuration. Changing this forces a new resource to be created.

property primaryReadKeys

public primaryReadKeys: pulumi.Output<ConfigurationStorePrimaryReadKey[]>;

A primaryReadKey block as defined below containing the primary read access key.

property primaryWriteKeys

public primaryWriteKeys: pulumi.Output<ConfigurationStorePrimaryWriteKey[]>;

A primaryWriteKey block as defined below containing the primary write access key.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the App Configuration. Changing this forces a new resource to be created.

property secondaryReadKeys

public secondaryReadKeys: pulumi.Output<ConfigurationStoreSecondaryReadKey[]>;

A secondaryReadKey block as defined below containing the secondary read access key.

property secondaryWriteKeys

public secondaryWriteKeys: pulumi.Output<ConfigurationStoreSecondaryWriteKey[]>;

A secondaryWriteKey block as defined below containing the secondary write access key.

property sku

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

The SKU name of the the App Configuration. Possible values are free and standard.

property tags

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

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

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

Functions

Function getConfigurationStore

getConfigurationStore(args: GetConfigurationStoreArgs, opts?: pulumi.InvokeOptions): Promise<GetConfigurationStoreResult>

Use this data source to access information about an existing App Configuration.

Example Usage

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

const example = azure.appconfiguration.getConfigurationStore({
    name: "existing",
    resourceGroupName: "existing",
});
export const id = example.then(example => example.id);

Others

interface ConfigurationStoreArgs

interface ConfigurationStoreArgs

The set of arguments for constructing a ConfigurationStore resource.

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 App Configuration. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the App Configuration. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<string>;

The SKU name of the the App Configuration. Possible values are free and standard.

property tags

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

A mapping of tags to assign to the resource.

interface ConfigurationStoreState

interface ConfigurationStoreState

Input properties used for looking up and filtering ConfigurationStore resources.

property endpoint

endpoint?: pulumi.Input<string>;

The URL of the App Configuration.

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 App Configuration. Changing this forces a new resource to be created.

property primaryReadKeys

primaryReadKeys?: pulumi.Input<pulumi.Input<ConfigurationStorePrimaryReadKey>[]>;

A primaryReadKey block as defined below containing the primary read access key.

property primaryWriteKeys

primaryWriteKeys?: pulumi.Input<pulumi.Input<ConfigurationStorePrimaryWriteKey>[]>;

A primaryWriteKey block as defined below containing the primary write access key.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the App Configuration. Changing this forces a new resource to be created.

property secondaryReadKeys

secondaryReadKeys?: pulumi.Input<pulumi.Input<ConfigurationStoreSecondaryReadKey>[]>;

A secondaryReadKey block as defined below containing the secondary read access key.

property secondaryWriteKeys

secondaryWriteKeys?: pulumi.Input<pulumi.Input<ConfigurationStoreSecondaryWriteKey>[]>;

A secondaryWriteKey block as defined below containing the secondary write access key.

property sku

sku?: pulumi.Input<string>;

The SKU name of the the App Configuration. Possible values are free and standard.

property tags

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

A mapping of tags to assign to the resource.

interface GetConfigurationStoreArgs

interface GetConfigurationStoreArgs

A collection of arguments for invoking getConfigurationStore.

property name

name: string;

The Name of this App Configuration.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group where the App Configuration exists.

interface GetConfigurationStoreResult

interface GetConfigurationStoreResult

A collection of values returned by getConfigurationStore.

property endpoint

endpoint: string;

The Endpoint used to access this App Configuration.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure Region where the App Configuration exists.

property name

name: string;

property primaryReadKeys

primaryReadKeys: GetConfigurationStorePrimaryReadKey[];

A primaryReadKey block as defined below containing the primary read access key.

property primaryWriteKeys

primaryWriteKeys: GetConfigurationStorePrimaryWriteKey[];

A primaryWriteKey block as defined below containing the primary write access key.

property resourceGroupName

resourceGroupName: string;

property secondaryReadKeys

secondaryReadKeys: GetConfigurationStoreSecondaryReadKey[];

A secondaryReadKey block as defined below containing the secondary read access key.

property secondaryWriteKeys

secondaryWriteKeys: GetConfigurationStoreSecondaryWriteKey[];

A secondaryWriteKey block as defined below containing the secondary write access key.

property sku

sku: string;

The name of the SKU used for this App Configuration.

property tags

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

A mapping of tags assigned to the App Configuration.