core

package
v1.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 12, 2020 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Overview

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetClientConfigResult 

type GetClientConfigResult struct {
	ClientId string `pulumi:"clientId"`
	// id is the provider-assigned unique ID for this managed resource.
	Id                            string `pulumi:"id"`
	ObjectId                      string `pulumi:"objectId"`
	ServicePrincipalApplicationId string `pulumi:"servicePrincipalApplicationId"`
	ServicePrincipalObjectId      string `pulumi:"servicePrincipalObjectId"`
	SubscriptionId                string `pulumi:"subscriptionId"`
	TenantId                      string `pulumi:"tenantId"`
}

A collection of values returned by getClientConfig.

func GetClientConfig added in v1.12.0 

func GetClientConfig(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetClientConfigResult, error)

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/client_config.html.markdown.

type GetResourcesArgs added in v1.3.1 

type GetResourcesArgs struct {
	// The name of the Resource.
	Name *string `pulumi:"name"`
	// A mapping of tags which the resource has to have in order to be included in the result.
	RequiredTags map[string]string `pulumi:"requiredTags"`
	// The name of the Resource group where the Resources are located.
	ResourceGroupName *string `pulumi:"resourceGroupName"`
	// The Resource Type of the Resources you want to list (e.g. `Microsoft.Network/virtualNetworks`). A full list of available Resource Types can be found [here](https://docs.microsoft.com/en-us/azure/azure-resource-manager/azure-services-resource-providers).
	Type *string `pulumi:"type"`
}

A collection of arguments for invoking getResources.

type GetResourcesResource added in v1.12.0 

type GetResourcesResource struct {
	// The ID of this Resource.
	Id string `pulumi:"id"`
	// The Azure Region in which this Resource exists.
	Location string `pulumi:"location"`
	// The name of the Resource.
	Name string `pulumi:"name"`
	// A map of tags assigned to this Resource.
	Tags map[string]string `pulumi:"tags"`
	// The Resource Type of the Resources you want to list (e.g. `Microsoft.Network/virtualNetworks`). A full list of available Resource Types can be found [here](https://docs.microsoft.com/en-us/azure/azure-resource-manager/azure-services-resource-providers).
	Type string `pulumi:"type"`
}

type GetResourcesResourceArgs added in v1.12.0 

type GetResourcesResourceArgs struct {
	// The ID of this Resource.
	Id pulumi.StringInput `pulumi:"id"`
	// The Azure Region in which this Resource exists.
	Location pulumi.StringInput `pulumi:"location"`
	// The name of the Resource.
	Name pulumi.StringInput `pulumi:"name"`
	// A map of tags assigned to this Resource.
	Tags pulumi.StringMapInput `pulumi:"tags"`
	// The Resource Type of the Resources you want to list (e.g. `Microsoft.Network/virtualNetworks`). A full list of available Resource Types can be found [here](https://docs.microsoft.com/en-us/azure/azure-resource-manager/azure-services-resource-providers).
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetResourcesResourceArgs) ElementType added in v1.12.0 

func (GetResourcesResourceArgs) ElementType() reflect.Type

func (GetResourcesResourceArgs) ToGetResourcesResourceOutput added in v1.12.0 

func (i GetResourcesResourceArgs) ToGetResourcesResourceOutput() GetResourcesResourceOutput

func (GetResourcesResourceArgs) ToGetResourcesResourceOutputWithContext added in v1.12.0 

func (i GetResourcesResourceArgs) ToGetResourcesResourceOutputWithContext(ctx context.Context) GetResourcesResourceOutput

type GetResourcesResourceArray added in v1.12.0 

type GetResourcesResourceArray []GetResourcesResourceInput

func (GetResourcesResourceArray) ElementType added in v1.12.0 

func (GetResourcesResourceArray) ElementType() reflect.Type

func (GetResourcesResourceArray) ToGetResourcesResourceArrayOutput added in v1.12.0 

func (i GetResourcesResourceArray) ToGetResourcesResourceArrayOutput() GetResourcesResourceArrayOutput

func (GetResourcesResourceArray) ToGetResourcesResourceArrayOutputWithContext added in v1.12.0 

func (i GetResourcesResourceArray) ToGetResourcesResourceArrayOutputWithContext(ctx context.Context) GetResourcesResourceArrayOutput

type GetResourcesResourceArrayInput added in v1.12.0 

type GetResourcesResourceArrayInput interface {
	pulumi.Input

	ToGetResourcesResourceArrayOutput() GetResourcesResourceArrayOutput
	ToGetResourcesResourceArrayOutputWithContext(context.Context) GetResourcesResourceArrayOutput
}

type GetResourcesResourceArrayOutput added in v1.12.0 

type GetResourcesResourceArrayOutput struct{ *pulumi.OutputState }

func (GetResourcesResourceArrayOutput) ElementType added in v1.12.0 

func (GetResourcesResourceArrayOutput) ElementType() reflect.Type

func (GetResourcesResourceArrayOutput) Index added in v1.12.0 

func (o GetResourcesResourceArrayOutput) Index(i pulumi.IntInput) GetResourcesResourceOutput

func (GetResourcesResourceArrayOutput) ToGetResourcesResourceArrayOutput added in v1.12.0 

func (o GetResourcesResourceArrayOutput) ToGetResourcesResourceArrayOutput() GetResourcesResourceArrayOutput

func (GetResourcesResourceArrayOutput) ToGetResourcesResourceArrayOutputWithContext added in v1.12.0 

func (o GetResourcesResourceArrayOutput) ToGetResourcesResourceArrayOutputWithContext(ctx context.Context) GetResourcesResourceArrayOutput

type GetResourcesResourceInput added in v1.12.0 

type GetResourcesResourceInput interface {
	pulumi.Input

	ToGetResourcesResourceOutput() GetResourcesResourceOutput
	ToGetResourcesResourceOutputWithContext(context.Context) GetResourcesResourceOutput
}

type GetResourcesResourceOutput added in v1.12.0 

type GetResourcesResourceOutput struct{ *pulumi.OutputState }

func (GetResourcesResourceOutput) ElementType added in v1.12.0 

func (GetResourcesResourceOutput) ElementType() reflect.Type

func (GetResourcesResourceOutput) Id added in v1.12.0 

func (o GetResourcesResourceOutput) Id() pulumi.StringOutput

The ID of this Resource.

func (GetResourcesResourceOutput) Location added in v1.12.0 

func (o GetResourcesResourceOutput) Location() pulumi.StringOutput

The Azure Region in which this Resource exists.

func (GetResourcesResourceOutput) Name added in v1.12.0 

func (o GetResourcesResourceOutput) Name() pulumi.StringOutput

The name of the Resource.

func (GetResourcesResourceOutput) Tags added in v1.12.0 

func (o GetResourcesResourceOutput) Tags() pulumi.StringMapOutput

A map of tags assigned to this Resource.

func (GetResourcesResourceOutput) ToGetResourcesResourceOutput added in v1.12.0 

func (o GetResourcesResourceOutput) ToGetResourcesResourceOutput() GetResourcesResourceOutput

func (GetResourcesResourceOutput) ToGetResourcesResourceOutputWithContext added in v1.12.0 

func (o GetResourcesResourceOutput) ToGetResourcesResourceOutputWithContext(ctx context.Context) GetResourcesResourceOutput

func (GetResourcesResourceOutput) Type added in v1.12.0 

func (o GetResourcesResourceOutput) Type() pulumi.StringOutput

The Resource Type of the Resources you want to list (e.g. `Microsoft.Network/virtualNetworks`). A full list of available Resource Types can be found [here](https://docs.microsoft.com/en-us/azure/azure-resource-manager/azure-services-resource-providers).

type GetResourcesResult added in v1.3.1 

type GetResourcesResult struct {
	// id is the provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The name of this Resource.
	Name              string            `pulumi:"name"`
	RequiredTags      map[string]string `pulumi:"requiredTags"`
	ResourceGroupName string            `pulumi:"resourceGroupName"`
	// One or more `resource` blocks as defined below.
	Resources []GetResourcesResource `pulumi:"resources"`
	// The type of this Resource. (e.g. `Microsoft.Network/virtualNetworks`).
	Type string `pulumi:"type"`
}

A collection of values returned by getResources.

func GetResources added in v1.12.0 

func GetResources(ctx *pulumi.Context, args *GetResourcesArgs, opts ...pulumi.InvokeOption) (*GetResourcesResult, error)

Use this data source to access information about existing resources.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/resources.html.markdown.

type GetSubscriptionArgs 

type GetSubscriptionArgs struct {
	// Specifies the ID of the subscription. If this argument is omitted, the subscription ID of the current Azure Resource Manager provider is used.
	SubscriptionId *string `pulumi:"subscriptionId"`
}

A collection of arguments for invoking getSubscription.

type GetSubscriptionResult 

type GetSubscriptionResult struct {
	// The subscription display name.
	DisplayName string `pulumi:"displayName"`
	// id is the provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The subscription location placement ID.
	LocationPlacementId string `pulumi:"locationPlacementId"`
	// The subscription quota ID.
	QuotaId string `pulumi:"quotaId"`
	// The subscription spending limit.
	SpendingLimit string `pulumi:"spendingLimit"`
	// The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.
	State string `pulumi:"state"`
	// The subscription GUID.
	SubscriptionId string `pulumi:"subscriptionId"`
	// The subscription tenant ID.
	TenantId string `pulumi:"tenantId"`
}

A collection of values returned by getSubscription.

func GetSubscription added in v1.12.0 

func GetSubscription(ctx *pulumi.Context, args *GetSubscriptionArgs, opts ...pulumi.InvokeOption) (*GetSubscriptionResult, error)

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/subscription.html.markdown.

type GetSubscriptionsArgs added in v0.16.6 

type GetSubscriptionsArgs struct {
	// A case-insensitive value which must be contained within the `displayName` field, used to filter the results
	DisplayNameContains *string `pulumi:"displayNameContains"`
	// A case-insensitive prefix which can be used to filter on the `displayName` field
	DisplayNamePrefix *string `pulumi:"displayNamePrefix"`
}

A collection of arguments for invoking getSubscriptions.

type GetSubscriptionsResult 

type GetSubscriptionsResult struct {
	DisplayNameContains *string `pulumi:"displayNameContains"`
	DisplayNamePrefix   *string `pulumi:"displayNamePrefix"`
	// id is the provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// One or more `subscription` blocks as defined below.
	Subscriptions []GetSubscriptionsSubscription `pulumi:"subscriptions"`
}

A collection of values returned by getSubscriptions.

func GetSubscriptions added in v1.12.0 

func GetSubscriptions(ctx *pulumi.Context, args *GetSubscriptionsArgs, opts ...pulumi.InvokeOption) (*GetSubscriptionsResult, error)

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/subscriptions.html.markdown.

type GetSubscriptionsSubscription added in v1.12.0 

type GetSubscriptionsSubscription struct {
	// The subscription display name.
	DisplayName string `pulumi:"displayName"`
	// The subscription location placement ID.
	LocationPlacementId string `pulumi:"locationPlacementId"`
	// The subscription quota ID.
	QuotaId string `pulumi:"quotaId"`
	// The subscription spending limit.
	SpendingLimit string `pulumi:"spendingLimit"`
	// The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.
	State string `pulumi:"state"`
	// The subscription GUID.
	SubscriptionId string `pulumi:"subscriptionId"`
	// The subscription tenant ID.
	TenantId string `pulumi:"tenantId"`
}

type GetSubscriptionsSubscriptionArgs added in v1.12.0 

type GetSubscriptionsSubscriptionArgs struct {
	// The subscription display name.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The subscription location placement ID.
	LocationPlacementId pulumi.StringInput `pulumi:"locationPlacementId"`
	// The subscription quota ID.
	QuotaId pulumi.StringInput `pulumi:"quotaId"`
	// The subscription spending limit.
	SpendingLimit pulumi.StringInput `pulumi:"spendingLimit"`
	// The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.
	State pulumi.StringInput `pulumi:"state"`
	// The subscription GUID.
	SubscriptionId pulumi.StringInput `pulumi:"subscriptionId"`
	// The subscription tenant ID.
	TenantId pulumi.StringInput `pulumi:"tenantId"`
}

func (GetSubscriptionsSubscriptionArgs) ElementType added in v1.12.0 

func (GetSubscriptionsSubscriptionArgs) ElementType() reflect.Type

func (GetSubscriptionsSubscriptionArgs) ToGetSubscriptionsSubscriptionOutput added in v1.12.0 

func (i GetSubscriptionsSubscriptionArgs) ToGetSubscriptionsSubscriptionOutput() GetSubscriptionsSubscriptionOutput

func (GetSubscriptionsSubscriptionArgs) ToGetSubscriptionsSubscriptionOutputWithContext added in v1.12.0 

func (i GetSubscriptionsSubscriptionArgs) ToGetSubscriptionsSubscriptionOutputWithContext(ctx context.Context) GetSubscriptionsSubscriptionOutput

type GetSubscriptionsSubscriptionArray added in v1.12.0 

type GetSubscriptionsSubscriptionArray []GetSubscriptionsSubscriptionInput

func (GetSubscriptionsSubscriptionArray) ElementType added in v1.12.0 

func (GetSubscriptionsSubscriptionArray) ElementType() reflect.Type

func (GetSubscriptionsSubscriptionArray) ToGetSubscriptionsSubscriptionArrayOutput added in v1.12.0 

func (i GetSubscriptionsSubscriptionArray) ToGetSubscriptionsSubscriptionArrayOutput() GetSubscriptionsSubscriptionArrayOutput

func (GetSubscriptionsSubscriptionArray) ToGetSubscriptionsSubscriptionArrayOutputWithContext added in v1.12.0 

func (i GetSubscriptionsSubscriptionArray) ToGetSubscriptionsSubscriptionArrayOutputWithContext(ctx context.Context) GetSubscriptionsSubscriptionArrayOutput

type GetSubscriptionsSubscriptionArrayInput added in v1.12.0 

type GetSubscriptionsSubscriptionArrayInput interface {
	pulumi.Input

	ToGetSubscriptionsSubscriptionArrayOutput() GetSubscriptionsSubscriptionArrayOutput
	ToGetSubscriptionsSubscriptionArrayOutputWithContext(context.Context) GetSubscriptionsSubscriptionArrayOutput
}

type GetSubscriptionsSubscriptionArrayOutput added in v1.12.0 

type GetSubscriptionsSubscriptionArrayOutput struct{ *pulumi.OutputState }

func (GetSubscriptionsSubscriptionArrayOutput) ElementType added in v1.12.0 

func (GetSubscriptionsSubscriptionArrayOutput) ElementType() reflect.Type

func (GetSubscriptionsSubscriptionArrayOutput) Index added in v1.12.0 

func (o GetSubscriptionsSubscriptionArrayOutput) Index(i pulumi.IntInput) GetSubscriptionsSubscriptionOutput

func (GetSubscriptionsSubscriptionArrayOutput) ToGetSubscriptionsSubscriptionArrayOutput added in v1.12.0 

func (o GetSubscriptionsSubscriptionArrayOutput) ToGetSubscriptionsSubscriptionArrayOutput() GetSubscriptionsSubscriptionArrayOutput

func (GetSubscriptionsSubscriptionArrayOutput) ToGetSubscriptionsSubscriptionArrayOutputWithContext added in v1.12.0 

func (o GetSubscriptionsSubscriptionArrayOutput) ToGetSubscriptionsSubscriptionArrayOutputWithContext(ctx context.Context) GetSubscriptionsSubscriptionArrayOutput

type GetSubscriptionsSubscriptionInput added in v1.12.0 

type GetSubscriptionsSubscriptionInput interface {
	pulumi.Input

	ToGetSubscriptionsSubscriptionOutput() GetSubscriptionsSubscriptionOutput
	ToGetSubscriptionsSubscriptionOutputWithContext(context.Context) GetSubscriptionsSubscriptionOutput
}

type GetSubscriptionsSubscriptionOutput added in v1.12.0 

type GetSubscriptionsSubscriptionOutput struct{ *pulumi.OutputState }

func (GetSubscriptionsSubscriptionOutput) DisplayName added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) DisplayName() pulumi.StringOutput

The subscription display name.

func (GetSubscriptionsSubscriptionOutput) ElementType added in v1.12.0 

func (GetSubscriptionsSubscriptionOutput) ElementType() reflect.Type

func (GetSubscriptionsSubscriptionOutput) LocationPlacementId added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) LocationPlacementId() pulumi.StringOutput

The subscription location placement ID.

func (GetSubscriptionsSubscriptionOutput) QuotaId added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) QuotaId() pulumi.StringOutput

The subscription quota ID.

func (GetSubscriptionsSubscriptionOutput) SpendingLimit added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) SpendingLimit() pulumi.StringOutput

The subscription spending limit.

func (GetSubscriptionsSubscriptionOutput) State added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) State() pulumi.StringOutput

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

func (GetSubscriptionsSubscriptionOutput) SubscriptionId added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) SubscriptionId() pulumi.StringOutput

The subscription GUID.

func (GetSubscriptionsSubscriptionOutput) TenantId added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) TenantId() pulumi.StringOutput

The subscription tenant ID.

func (GetSubscriptionsSubscriptionOutput) ToGetSubscriptionsSubscriptionOutput added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) ToGetSubscriptionsSubscriptionOutput() GetSubscriptionsSubscriptionOutput

func (GetSubscriptionsSubscriptionOutput) ToGetSubscriptionsSubscriptionOutputWithContext added in v1.12.0 

func (o GetSubscriptionsSubscriptionOutput) ToGetSubscriptionsSubscriptionOutputWithContext(ctx context.Context) GetSubscriptionsSubscriptionOutput

type GetUserAssignedIdentityArgs added in v0.18.3 

type GetUserAssignedIdentityArgs struct {
	// The name of the User Assigned Identity.
	Name string `pulumi:"name"`
	// The name of the Resource Group in which the User Assigned Identity exists.
	ResourceGroupName string `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getUserAssignedIdentity.

type GetUserAssignedIdentityResult added in v0.18.3 

type GetUserAssignedIdentityResult struct {
	// The Client ID of the User Assigned Identity.
	ClientId string `pulumi:"clientId"`
	// id is the provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The Azure location where the User Assigned Identity exists.
	Location string `pulumi:"location"`
	Name     string `pulumi:"name"`
	// The Service Principal ID of the User Assigned Identity.
	PrincipalId       string `pulumi:"principalId"`
	ResourceGroupName string `pulumi:"resourceGroupName"`
	// A mapping of tags assigned to the User Assigned Identity.
	Tags map[string]string `pulumi:"tags"`
}

A collection of values returned by getUserAssignedIdentity.

func GetUserAssignedIdentity added in v1.12.0 

func GetUserAssignedIdentity(ctx *pulumi.Context, args *GetUserAssignedIdentityArgs, opts ...pulumi.InvokeOption) (*GetUserAssignedIdentityResult, error)

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/user_assigned_identity_legacy.html.markdown.

type LookupResourceGroupArgs added in v1.12.0 

type LookupResourceGroupArgs struct {
	// Specifies the name of the resource group.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getResourceGroup.

type LookupResourceGroupResult added in v1.12.0 

type LookupResourceGroupResult struct {
	// id is the provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The location of the resource group.
	Location string `pulumi:"location"`
	Name     string `pulumi:"name"`
	// A mapping of tags assigned to the resource group.
	Tags map[string]string `pulumi:"tags"`
}

A collection of values returned by getResourceGroup.

func LookupResourceGroup 

func LookupResourceGroup(ctx *pulumi.Context, args *LookupResourceGroupArgs, opts ...pulumi.InvokeOption) (*LookupResourceGroupResult, error)

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/resource_group.html.markdown.

type ResourceGroup 

type ResourceGroup struct {
	pulumi.CustomResourceState

	// The location where the resource group should be created.
	// For a list of all Azure locations, please consult [this link](http://azure.microsoft.com/en-us/regions/) or run `az account list-locations --output table`.
	Location pulumi.StringOutput `pulumi:"location"`
	// The name of the resource group. Must be unique on your
	// Azure subscription.
	Name pulumi.StringOutput `pulumi:"name"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a resource group on Azure.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/resource_group.html.markdown.

func GetResourceGroup 

func GetResourceGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceGroupState, opts ...pulumi.ResourceOption) (*ResourceGroup, error)

GetResourceGroup gets an existing ResourceGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewResourceGroup 

func NewResourceGroup(ctx *pulumi.Context,
	name string, args *ResourceGroupArgs, opts ...pulumi.ResourceOption) (*ResourceGroup, error)

NewResourceGroup registers a new resource with the given unique name, arguments, and options.

type ResourceGroupArgs 

type ResourceGroupArgs struct {
	// The location where the resource group should be created.
	// For a list of all Azure locations, please consult [this link](http://azure.microsoft.com/en-us/regions/) or run `az account list-locations --output table`.
	Location pulumi.StringPtrInput
	// The name of the resource group. Must be unique on your
	// Azure subscription.
	Name pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a ResourceGroup resource.

func (ResourceGroupArgs) ElementType added in v1.12.0 

func (ResourceGroupArgs) ElementType() reflect.Type

type ResourceGroupState 

type ResourceGroupState struct {
	// The location where the resource group should be created.
	// For a list of all Azure locations, please consult [this link](http://azure.microsoft.com/en-us/regions/) or run `az account list-locations --output table`.
	Location pulumi.StringPtrInput
	// The name of the resource group. Must be unique on your
	// Azure subscription.
	Name pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (ResourceGroupState) ElementType added in v1.12.0 

func (ResourceGroupState) ElementType() reflect.Type

type TemplateDeployment 

type TemplateDeployment struct {
	pulumi.CustomResourceState

	// 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.
	DeploymentMode pulumi.StringOutput `pulumi:"deploymentMode"`
	// Specifies the name of the template deployment. Changing this forces a
	// new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// 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"]`.
	Outputs pulumi.StringMapOutput `pulumi:"outputs"`
	// Specifies the name and value pairs that define the deployment parameters for the template.
	Parameters pulumi.StringMapOutput `pulumi:"parameters"`
	// Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references
	ParametersBody pulumi.StringPtrOutput `pulumi:"parametersBody"`
	// The name of the resource group in which to
	// create the template deployment.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// Specifies the JSON definition for the template.
	TemplateBody pulumi.StringOutput `pulumi:"templateBody"`
}

Manages 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](https://docs.microsoft.com/en-us/rest/api/resources/deployments#Deployments_Delete).

## Note

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](https://docs.microsoft.com/en-us/rest/api/resources/deployments#Deployments_Delete).

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/template_deployment.html.markdown.

func GetTemplateDeployment 

func GetTemplateDeployment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TemplateDeploymentState, opts ...pulumi.ResourceOption) (*TemplateDeployment, error)

GetTemplateDeployment gets an existing TemplateDeployment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTemplateDeployment 

func NewTemplateDeployment(ctx *pulumi.Context,
	name string, args *TemplateDeploymentArgs, opts ...pulumi.ResourceOption) (*TemplateDeployment, error)

NewTemplateDeployment registers a new resource with the given unique name, arguments, and options.

type TemplateDeploymentArgs 

type TemplateDeploymentArgs struct {
	// 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.
	DeploymentMode pulumi.StringInput
	// Specifies the name of the template deployment. Changing this forces a
	// new resource to be created.
	Name pulumi.StringPtrInput
	// Specifies the name and value pairs that define the deployment parameters for the template.
	Parameters pulumi.StringMapInput
	// Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references
	ParametersBody pulumi.StringPtrInput
	// The name of the resource group in which to
	// create the template deployment.
	ResourceGroupName pulumi.StringInput
	// Specifies the JSON definition for the template.
	TemplateBody pulumi.StringPtrInput
}

The set of arguments for constructing a TemplateDeployment resource.

func (TemplateDeploymentArgs) ElementType added in v1.12.0 

func (TemplateDeploymentArgs) ElementType() reflect.Type

type TemplateDeploymentState 

type TemplateDeploymentState struct {
	// 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.
	DeploymentMode pulumi.StringPtrInput
	// Specifies the name of the template deployment. Changing this forces a
	// new resource to be created.
	Name pulumi.StringPtrInput
	// 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"]`.
	Outputs pulumi.StringMapInput
	// Specifies the name and value pairs that define the deployment parameters for the template.
	Parameters pulumi.StringMapInput
	// Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references
	ParametersBody pulumi.StringPtrInput
	// The name of the resource group in which to
	// create the template deployment.
	ResourceGroupName pulumi.StringPtrInput
	// Specifies the JSON definition for the template.
	TemplateBody pulumi.StringPtrInput
}

func (TemplateDeploymentState) ElementType added in v1.12.0 

func (TemplateDeploymentState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.