core

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.core.AwaitableGetClientConfigResult(client_id=None, service_principal_application_id=None, service_principal_object_id=None, subscription_id=None, tenant_id=None, id=None)
class pulumi_azure.core.AwaitableGetResourceGroupResult(location=None, name=None, tags=None, id=None)
class pulumi_azure.core.AwaitableGetSubscriptionResult(display_name=None, location_placement_id=None, quota_id=None, spending_limit=None, state=None, subscription_id=None, tenant_id=None, id=None)
class pulumi_azure.core.AwaitableGetSubscriptionsResult(display_name_contains=None, display_name_prefix=None, subscriptions=None, id=None)
class pulumi_azure.core.AwaitableGetUserAssignedIdentityResult(client_id=None, location=None, name=None, principal_id=None, resource_group_name=None, tags=None, id=None)
class pulumi_azure.core.GetClientConfigResult(client_id=None, service_principal_application_id=None, service_principal_object_id=None, subscription_id=None, tenant_id=None, id=None)

A collection of values returned by getClientConfig.

id = None

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

class pulumi_azure.core.GetResourceGroupResult(location=None, name=None, tags=None, id=None)

A collection of values returned by getResourceGroup.

location = None

The location of the resource group.

tags = None

A mapping of tags assigned to the resource group.

id = None

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

class pulumi_azure.core.GetSubscriptionResult(display_name=None, location_placement_id=None, quota_id=None, spending_limit=None, state=None, subscription_id=None, tenant_id=None, id=None)

A collection of values returned by getSubscription.

display_name = None

The subscription display name.

location_placement_id = None

The subscription location placement ID.

quota_id = None

The subscription quota ID.

spending_limit = None

The subscription spending limit.

state = None

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

subscription_id = None

The subscription GUID.

tenant_id = None

The subscription tenant ID.

id = None

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

class pulumi_azure.core.GetSubscriptionsResult(display_name_contains=None, display_name_prefix=None, subscriptions=None, id=None)

A collection of values returned by getSubscriptions.

subscriptions = None

One or more subscription blocks as defined below.

id = None

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

class pulumi_azure.core.GetUserAssignedIdentityResult(client_id=None, location=None, name=None, principal_id=None, resource_group_name=None, tags=None, id=None)

A collection of values returned by getUserAssignedIdentity.

client_id = None

The Client ID of the User Assigned Identity.

location = None

The Azure location where the User Assigned Identity exists.

principal_id = None

The Service Principal ID of the User Assigned Identity.

tags = None

A mapping of tags assigned to the User Assigned Identity.

id = None

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

class pulumi_azure.core.ResourceGroup(resource_name, opts=None, location=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages a resource group on Azure.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – 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.

  • name (pulumi.Input[str]) – The name of the resource group. Must be unique on your Azure subscription.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

location = None

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.

name = None

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

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, location=None, name=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) –

    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.

  • name (pulumi.Input[str]) – The name of the resource group. Must be unique on your Azure subscription.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.core.TemplateDeployment(resource_name, opts=None, deployment_mode=None, name=None, parameters=None, parameters_body=None, resource_group_name=None, template_body=None, __props__=None, __name__=None, __opts__=None)

Manage a template deployment of resources

Note on ARM Template Deployments: Due to the way the underlying Azure API is designed, this provider can only manage the deployment of the ARM Template - and not any resources which are created by it. This means that when deleting the core.TemplateDeployment resource, this provider 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.

This provider does not know about the individual resources created by Azure using a deployment template and therefore cannot delete these resources during a destroy. Destroying a template deployment removes the associated deployment operations, but will not delete the Azure resources created by the deployment. In order to delete these resources, the containing resource group must also be destroyed. More information.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • deployment_mode (pulumi.Input[str]) – 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 this provider will not be aware of this.

  • name (pulumi.Input[str]) – Specifies the name of the template deployment. Changing this forces a new resource to be created.

  • parameters (pulumi.Input[dict]) – Specifies the name and value pairs that define the deployment parameters for the template.

  • parameters_body (pulumi.Input[str]) – Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the template deployment.

  • template_body (pulumi.Input[str]) – Specifies the JSON definition for the template.

deployment_mode = None

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 this provider will not be aware of this.

name = None

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

outputs = None

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"].

parameters = None

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

parameters_body = None

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

resource_group_name = None

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

template_body = None

Specifies the JSON definition for the template.

static get(resource_name, id, opts=None, deployment_mode=None, name=None, outputs=None, parameters=None, parameters_body=None, resource_group_name=None, template_body=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • deployment_mode (pulumi.Input[str]) – 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 this provider will not be aware of this.

  • name (pulumi.Input[str]) – Specifies the name of the template deployment. Changing this forces a new resource to be created.

  • outputs (pulumi.Input[dict]) – 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"].

  • parameters (pulumi.Input[dict]) – Specifies the name and value pairs that define the deployment parameters for the template.

  • parameters_body (pulumi.Input[str]) – Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the template deployment.

  • template_body (pulumi.Input[str]) – Specifies the JSON definition for the template.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.core.get_client_config(opts=None)

Use this data source to access the configuration of the AzureRM provider.

pulumi_azure.core.get_resource_group(name=None, opts=None)

Use this data source to access information about an existing Resource Group.

Parameters

name (str) – Specifies the name of the resource group.

pulumi_azure.core.get_subscription(subscription_id=None, opts=None)

Use this data source to access information about an existing Subscription.

Parameters

subscription_id (str) – Specifies the ID of the subscription. If this argument is omitted, the subscription ID of the current Azure Resource Manager provider is used.

pulumi_azure.core.get_subscriptions(display_name_contains=None, display_name_prefix=None, opts=None)

Use this data source to access information about all the Subscriptions currently available.

Parameters
  • display_name_contains (str) – A case-insensitive value which must be contained within the display_name field, used to filter the results

  • display_name_prefix (str) – A case-insensitive prefix which can be used to filter on the display_name field

pulumi_azure.core.get_user_assigned_identity(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing User Assigned Identity.

Parameters
  • name (str) – The name of the User Assigned Identity.

  • resource_group_name (str) – The name of the Resource Group in which the User Assigned Identity exists.