Fork me on GitHub

Module core

@pulumi/azure > core

Index

core/getClientConfig.ts core/getResourceGroup.ts core/getSubscription.ts core/getSubscriptions.ts core/resourceGroup.ts core/templateDeployment.ts

class ResourceGroup

Manages a resource group on Azure.

constructor

new ResourceGroup(name: string, args: ResourceGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ResourceGroup 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?: ResourceGroupState): ResourceGroup

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 location

public location: pulumi.Output<string>;

The location where the resource group should be created. For a list of all Azure locations, please consult this link or run az account list-locations --output table.

property name

public name: pulumi.Output<string>;

The name of the resource group. Must be unique on your Azure subscription.

property tags

public tags: pulumi.Output<{ ... }>;

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.

class TemplateDeployment

Manage a template deployment of resources

~> Note on ARM Template Deployments: Due to the way the underlying Azure API is designed, Terraform can only manage the deployment of the ARM Template - and not any resources which are created by it. This means that when deleting the azurerm_template_deployment resource, Terraform will only remove the reference to the deployment, whilst leaving any resources created by that ARM Template Deployment. One workaround for this is to use a unique Resource Group for each ARM Template Deployment, which means deleting the Resource Group would contain any resources created within it - however this isn’t ideal. More information.

constructor

new TemplateDeployment(name: string, args: TemplateDeploymentArgs, opts?: pulumi.CustomResourceOptions)

Create a TemplateDeployment 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?: TemplateDeploymentState): TemplateDeployment

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

static isInstance(obj: any): boolean

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

property deploymentMode

public deploymentMode: pulumi.Output<string>;

Specifies the mode that is used to deploy resources. This value could be either Incremental or Complete. Note that you will almost always want this to be set to Incremental otherwise the deployment will destroy all infrastructure not specified within the template, and Terraform will not be aware of this.

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

property outputs

public outputs: pulumi.Output<{ ... }>;

A map of supported scalar output types returned from the deployment (currently, Azure Template Deployment outputs of type String, Int and Bool are supported, and are converted to strings - others will be ignored) and can be accessed using .outputs["name"].

property parameters

public parameters: pulumi.Output<{ ... } | undefined>;

Specifies the name and value pairs that define the deployment parameters for the template.

property parametersBody

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

Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the template deployment.

property templateBody

public templateBody: pulumi.Output<string>;

Specifies the JSON definition for the template.

property urn

urn: Output<URN>;

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

function getClientConfig

getClientConfig(opts?: pulumi.InvokeOptions): Promise<GetClientConfigResult>

Use this data source to access the configuration of the Azure Resource Manager provider.

function getResourceGroup

getResourceGroup(args: GetResourceGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetResourceGroupResult>

Use this data source to access the properties of an Azure resource group.

function getSubscription

getSubscription(args?: GetSubscriptionArgs, opts?: pulumi.InvokeOptions): Promise<GetSubscriptionResult>

Use this data source to access the properties of an Azure subscription.

function getSubscriptions

getSubscriptions(opts?: pulumi.InvokeOptions): Promise<GetSubscriptionsResult>

Use this data source to access a list of all Azure subscriptions currently available.

interface GetClientConfigResult

A collection of values returned by getClientConfig.

property clientId

clientId: string;

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property servicePrincipalApplicationId

servicePrincipalApplicationId: string;

property servicePrincipalObjectId

servicePrincipalObjectId: string;

property subscriptionId

subscriptionId: string;

property tenantId

tenantId: string;

interface GetResourceGroupArgs

A collection of arguments for invoking getResourceGroup.

property name

name: string;

Specifies the name of the resource group.

interface GetResourceGroupResult

A collection of values returned by getResourceGroup.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property location

location: string;

The location of the resource group.

property tags

tags: { ... };

A mapping of tags assigned to the resource group.

interface GetSubscriptionArgs

A collection of arguments for invoking getSubscription.

property subscriptionId

subscriptionId?: string;

Specifies the ID of the subscription. If this argument is omitted, the subscription ID of the current Azure Resource Manager provider is used.

interface GetSubscriptionResult

A collection of values returned by getSubscription.

property displayName

displayName: string;

The subscription display name.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property locationPlacementId

locationPlacementId: string;

The subscription location placement ID.

property quotaId

quotaId: string;

The subscription quota ID.

property spendingLimit

spendingLimit: string;

The subscription spending limit.

property state

state: string;

The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.

property subscriptionId

subscriptionId: string;

interface GetSubscriptionsResult

A collection of values returned by getSubscriptions.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property subscriptions

subscriptions: { ... }[];

One or more subscription blocks as defined below.

interface ResourceGroupArgs

The set of arguments for constructing a ResourceGroup resource.

property location

location: pulumi.Input<string>;

The location where the resource group should be created. For a list of all Azure locations, please consult this link or run az account list-locations --output table.

property name

name?: pulumi.Input<string>;

The name of the resource group. Must be unique on your Azure subscription.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface ResourceGroupState

Input properties used for looking up and filtering ResourceGroup resources.

property location

location?: pulumi.Input<string>;

The location where the resource group should be created. For a list of all Azure locations, please consult this link or run az account list-locations --output table.

property name

name?: pulumi.Input<string>;

The name of the resource group. Must be unique on your Azure subscription.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface TemplateDeploymentArgs

The set of arguments for constructing a TemplateDeployment resource.

property deploymentMode

deploymentMode: pulumi.Input<string>;

Specifies the mode that is used to deploy resources. This value could be either Incremental or Complete. Note that you will almost always want this to be set to Incremental otherwise the deployment will destroy all infrastructure not specified within the template, and Terraform will not be aware of this.

property name

name?: pulumi.Input<string>;

Specifies the name of the template deployment. Changing this forces a new resource to be created.

property parameters

parameters?: pulumi.Input<{ ... }>;

Specifies the name and value pairs that define the deployment parameters for the template.

property parametersBody

parametersBody?: pulumi.Input<string>;

Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the template deployment.

property templateBody

templateBody?: pulumi.Input<string>;

Specifies the JSON definition for the template.

interface TemplateDeploymentState

Input properties used for looking up and filtering TemplateDeployment resources.

property deploymentMode

deploymentMode?: pulumi.Input<string>;

Specifies the mode that is used to deploy resources. This value could be either Incremental or Complete. Note that you will almost always want this to be set to Incremental otherwise the deployment will destroy all infrastructure not specified within the template, and Terraform will not be aware of this.

property name

name?: pulumi.Input<string>;

Specifies the name of the template deployment. Changing this forces a new resource to be created.

property outputs

outputs?: pulumi.Input<{ ... }>;

A map of supported scalar output types returned from the deployment (currently, Azure Template Deployment outputs of type String, Int and Bool are supported, and are converted to strings - others will be ignored) and can be accessed using .outputs["name"].

property parameters

parameters?: pulumi.Input<{ ... }>;

Specifies the name and value pairs that define the deployment parameters for the template.

property parametersBody

parametersBody?: pulumi.Input<string>;

Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the template deployment.

property templateBody

templateBody?: pulumi.Input<string>;

Specifies the JSON definition for the template.