Documentation
¶
Index ¶
- type GetClientConfigResult
- type GetResourceGroupArgs
- type GetResourceGroupResult
- type GetResourcesArgs
- type GetResourcesResult
- type GetSubscriptionArgs
- type GetSubscriptionResult
- type GetSubscriptionsArgs
- type GetSubscriptionsResult
- type GetUserAssignedIdentityArgs
- type GetUserAssignedIdentityResult
- type ResourceGroup
- type ResourceGroupArgs
- type ResourceGroupState
- type TemplateDeployment
- func (r *TemplateDeployment) DeploymentMode() pulumi.StringOutput
- func (r *TemplateDeployment) ID() pulumi.IDOutput
- func (r *TemplateDeployment) Name() pulumi.StringOutput
- func (r *TemplateDeployment) Outputs() pulumi.MapOutput
- func (r *TemplateDeployment) Parameters() pulumi.MapOutput
- func (r *TemplateDeployment) ParametersBody() pulumi.StringOutput
- func (r *TemplateDeployment) ResourceGroupName() pulumi.StringOutput
- func (r *TemplateDeployment) TemplateBody() pulumi.StringOutput
- func (r *TemplateDeployment) URN() pulumi.URNOutput
- type TemplateDeploymentArgs
- type TemplateDeploymentState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetClientConfigResult ¶
type GetClientConfigResult struct { ClientId interface{} ObjectId interface{} ServicePrincipalApplicationId interface{} ServicePrincipalObjectId interface{} SubscriptionId interface{} TenantId interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getClientConfig.
func LookupClientConfig ¶
func LookupClientConfig(ctx *pulumi.Context) (*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 GetResourceGroupArgs ¶
type GetResourceGroupArgs struct {
// Specifies the name of the resource group.
Name interface{}
}
A collection of arguments for invoking getResourceGroup.
type GetResourceGroupResult ¶
type GetResourceGroupResult struct { // The location of the resource group. Location interface{} Name interface{} // A mapping of tags assigned to the resource group. Tags interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getResourceGroup.
func LookupResourceGroup ¶
func LookupResourceGroup(ctx *pulumi.Context, args *GetResourceGroupArgs) (*GetResourceGroupResult, 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 GetResourcesArgs ¶ added in v1.3.1
type GetResourcesArgs struct { // The name of the Resource. Name interface{} // A mapping of tags which the resource has to have in order to be included in the result. RequiredTags interface{} // The name of the Resource group where the Resources are located. ResourceGroupName interface{} // 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 interface{} }
A collection of arguments for invoking getResources.
type GetResourcesResult ¶ added in v1.3.1
type GetResourcesResult struct { // The name of this resource. Name interface{} RequiredTags interface{} ResourceGroupName interface{} // One or more `resource` blocks as defined below. Resources interface{} // The type of this resoource. Type interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getResources.
func LookupResources ¶ added in v1.3.1
func LookupResources(ctx *pulumi.Context, args *GetResourcesArgs) (*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 interface{}
}
A collection of arguments for invoking getSubscription.
type GetSubscriptionResult ¶
type GetSubscriptionResult struct { // The subscription display name. DisplayName interface{} // The subscription location placement ID. LocationPlacementId interface{} // The subscription quota ID. QuotaId interface{} // The subscription spending limit. SpendingLimit interface{} // The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted. State interface{} // The subscription GUID. SubscriptionId interface{} // The subscription tenant ID. TenantId interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getSubscription.
func LookupSubscription ¶
func LookupSubscription(ctx *pulumi.Context, args *GetSubscriptionArgs) (*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 interface{} // A case-insensitive prefix which can be used to filter on the `displayName` field DisplayNamePrefix interface{} }
A collection of arguments for invoking getSubscriptions.
type GetSubscriptionsResult ¶
type GetSubscriptionsResult struct { DisplayNameContains interface{} DisplayNamePrefix interface{} // One or more `subscription` blocks as defined below. Subscriptions interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getSubscriptions.
func LookupSubscriptions ¶
func LookupSubscriptions(ctx *pulumi.Context, args *GetSubscriptionsArgs) (*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 GetUserAssignedIdentityArgs ¶ added in v0.18.3
type GetUserAssignedIdentityArgs struct { // The name of the User Assigned Identity. Name interface{} // The name of the Resource Group in which the User Assigned Identity exists. ResourceGroupName interface{} }
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 interface{} // The Azure location where the User Assigned Identity exists. Location interface{} Name interface{} // The Service Principal ID of the User Assigned Identity. PrincipalId interface{} ResourceGroupName interface{} // A mapping of tags assigned to the User Assigned Identity. Tags interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getUserAssignedIdentity.
func LookupUserAssignedIdentity ¶ added in v0.18.3
func LookupUserAssignedIdentity(ctx *pulumi.Context, args *GetUserAssignedIdentityArgs) (*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 ResourceGroup ¶
type ResourceGroup struct {
// contains filtered or unexported fields
}
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.ID, state *ResourceGroupState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*ResourceGroup, error)
NewResourceGroup registers a new resource with the given unique name, arguments, and options.
func (*ResourceGroup) ID ¶
func (r *ResourceGroup) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*ResourceGroup) Location ¶
func (r *ResourceGroup) Location() pulumi.StringOutput
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`.
func (*ResourceGroup) Name ¶
func (r *ResourceGroup) Name() pulumi.StringOutput
The name of the resource group. Must be unique on your Azure subscription.
func (*ResourceGroup) Tags ¶
func (r *ResourceGroup) Tags() pulumi.MapOutput
A mapping of tags to assign to the resource.
func (*ResourceGroup) URN ¶
func (r *ResourceGroup) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
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 interface{} // The name of the resource group. Must be unique on your // Azure subscription. Name interface{} // A mapping of tags to assign to the resource. Tags interface{} }
The set of arguments for constructing a ResourceGroup resource.
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 interface{} // The name of the resource group. Must be unique on your // Azure subscription. Name interface{} // A mapping of tags to assign to the resource. Tags interface{} }
Input properties used for looking up and filtering ResourceGroup resources.
type TemplateDeployment ¶
type TemplateDeployment struct {
// contains filtered or unexported fields
}
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.ID, state *TemplateDeploymentState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*TemplateDeployment, error)
NewTemplateDeployment registers a new resource with the given unique name, arguments, and options.
func (*TemplateDeployment) DeploymentMode ¶
func (r *TemplateDeployment) DeploymentMode() pulumi.StringOutput
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.
func (*TemplateDeployment) ID ¶
func (r *TemplateDeployment) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*TemplateDeployment) Name ¶
func (r *TemplateDeployment) Name() pulumi.StringOutput
Specifies the name of the template deployment. Changing this forces a new resource to be created.
func (*TemplateDeployment) Outputs ¶
func (r *TemplateDeployment) Outputs() pulumi.MapOutput
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"]`.
func (*TemplateDeployment) Parameters ¶
func (r *TemplateDeployment) Parameters() pulumi.MapOutput
Specifies the name and value pairs that define the deployment parameters for the template.
func (*TemplateDeployment) ParametersBody ¶
func (r *TemplateDeployment) ParametersBody() pulumi.StringOutput
Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references
func (*TemplateDeployment) ResourceGroupName ¶
func (r *TemplateDeployment) ResourceGroupName() pulumi.StringOutput
The name of the resource group in which to create the template deployment.
func (*TemplateDeployment) TemplateBody ¶
func (r *TemplateDeployment) TemplateBody() pulumi.StringOutput
Specifies the JSON definition for the template.
func (*TemplateDeployment) URN ¶
func (r *TemplateDeployment) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
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 interface{} // Specifies the name of the template deployment. Changing this forces a // new resource to be created. Name interface{} // Specifies the name and value pairs that define the deployment parameters for the template. Parameters interface{} // Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references ParametersBody interface{} // The name of the resource group in which to // create the template deployment. ResourceGroupName interface{} // Specifies the JSON definition for the template. TemplateBody interface{} }
The set of arguments for constructing a TemplateDeployment resource.
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 interface{} // Specifies the name of the template deployment. Changing this forces a // new resource to be created. Name interface{} // 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 interface{} // Specifies the name and value pairs that define the deployment parameters for the template. Parameters interface{} // Specifies a valid Azure JSON parameters file that define the deployment parameters. It can contain KeyVault references ParametersBody interface{} // The name of the resource group in which to // create the template deployment. ResourceGroupName interface{} // Specifies the JSON definition for the template. TemplateBody interface{} }
Input properties used for looking up and filtering TemplateDeployment resources.