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.
managedapplication¶
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.managedapplication.Application(resource_name, opts=None, application_definition_id=None, kind=None, location=None, managed_resource_group_name=None, name=None, parameters=None, plan=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ Manages a Managed Application.
import pulumi import pulumi_azure as azure current = azure.core.get_client_config() builtin = azure.authorization.get_role_definition(name="Contributor") example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe") example_definition = azure.managedapplication.Definition("exampleDefinition", location=example_resource_group.location, resource_group_name=example_resource_group.name, lock_level="ReadOnly", package_file_uri="https://github.com/Azure/azure-managedapp-samples/raw/master/Managed Application Sample Packages/201-managed-storage-account/managedstorage.zip", display_name="TestManagedAppDefinition", description="Test Managed App Definition", authorization=[{ "service_principal_id": current.object_id, "role_definition_id": builtin.id.split("/")[len(builtin.id.split("/")) - 1], }]) example_application = azure.managedapplication.Application("exampleApplication", location=example_resource_group.location, resource_group_name=example_resource_group.name, kind="ServiceCatalog", managed_resource_group_name="infrastructureGroup", application_definition_id=example_definition.id, parameters={ "location": example_resource_group.location, "storageAccountNamePrefix": "storeNamePrefix", "storage_account_type": "Standard_LRS", })
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_definition_id (pulumi.Input[str]) – The application definition ID to deploy.
kind (pulumi.Input[str]) – The kind of the managed application to deploy. Possible values are
MarketPlaceandServiceCatalog. Changing this forces a new resource to be created.location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managed_resource_group_name (pulumi.Input[str]) – The name of the target resource group where all the resources deployed by the managed application will reside. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Managed Application. Changing this forces a new resource to be created.
parameters (pulumi.Input[dict]) – A mapping of name and value pairs to pass to the managed application as parameters.
plan (pulumi.Input[dict]) – One
planblock as defined below.resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Managed Application should exist. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
The plan object supports the following:
name(pulumi.Input[str]) - Specifies the name of the plan from the marketplace.product(pulumi.Input[str]) - Specifies the product of the plan from the marketplace.promotionCode(pulumi.Input[str]) - Specifies the promotion code to use with the plan.publisher(pulumi.Input[str]) - Specifies the publisher of the plan.version(pulumi.Input[str]) - Specifies the version of the plan from the marketplace.
application_definition_id: pulumi.Output[str] = None¶The application definition ID to deploy.
kind: pulumi.Output[str] = None¶The kind of the managed application to deploy. Possible values are
MarketPlaceandServiceCatalog. Changing this forces a new resource to be created.
location: pulumi.Output[str] = None¶Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managed_resource_group_name: pulumi.Output[str] = None¶The name of the target resource group where all the resources deployed by the managed application will reside. Changing this forces a new resource to be created.
name: pulumi.Output[str] = None¶Specifies the name of the Managed Application. Changing this forces a new resource to be created.
outputs: pulumi.Output[dict] = None¶The name and value pairs that define the managed application outputs.
parameters: pulumi.Output[dict] = None¶A mapping of name and value pairs to pass to the managed application as parameters.
plan: pulumi.Output[dict] = None¶One
planblock as defined below.name(str) - Specifies the name of the plan from the marketplace.product(str) - Specifies the product of the plan from the marketplace.promotionCode(str) - Specifies the promotion code to use with the plan.publisher(str) - Specifies the publisher of the plan.version(str) - Specifies the version of the plan from the marketplace.
resource_group_name: pulumi.Output[str] = None¶The name of the Resource Group where the Managed Application should exist. Changing this forces a new resource to be created.
A mapping of tags to assign to the resource.
- static
get(resource_name, id, opts=None, application_definition_id=None, kind=None, location=None, managed_resource_group_name=None, name=None, outputs=None, parameters=None, plan=None, resource_group_name=None, tags=None)¶ Get an existing Application 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.
application_definition_id (pulumi.Input[str]) – The application definition ID to deploy.
kind (pulumi.Input[str]) – The kind of the managed application to deploy. Possible values are
MarketPlaceandServiceCatalog. Changing this forces a new resource to be created.location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
managed_resource_group_name (pulumi.Input[str]) – The name of the target resource group where all the resources deployed by the managed application will reside. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Managed Application. Changing this forces a new resource to be created.
outputs (pulumi.Input[dict]) – The name and value pairs that define the managed application outputs.
parameters (pulumi.Input[dict]) – A mapping of name and value pairs to pass to the managed application as parameters.
plan (pulumi.Input[dict]) – One
planblock as defined below.resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Managed Application should exist. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
The plan object supports the following:
name(pulumi.Input[str]) - Specifies the name of the plan from the marketplace.product(pulumi.Input[str]) - Specifies the product of the plan from the marketplace.promotionCode(pulumi.Input[str]) - Specifies the promotion code to use with the plan.publisher(pulumi.Input[str]) - Specifies the publisher of the plan.version(pulumi.Input[str]) - Specifies the version of the plan from the marketplace.
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.managedapplication.AwaitableGetDefinitionResult(id=None, location=None, name=None, resource_group_name=None)¶
- class
pulumi_azure.managedapplication.Definition(resource_name, opts=None, authorizations=None, create_ui_definition=None, description=None, display_name=None, location=None, lock_level=None, main_template=None, name=None, package_enabled=None, package_file_uri=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ Manages a Managed Application Definition.
import pulumi import pulumi_azure as azure current = azure.core.get_client_config() example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe") example_definition = azure.managedapplication.Definition("exampleDefinition", location=example_resource_group.location, resource_group_name=example_resource_group.name, lock_level="ReadOnly", package_file_uri="https://github.com/Azure/azure-managedapp-samples/raw/master/Managed Application Sample Packages/201-managed-storage-account/managedstorage.zip", display_name="TestManagedApplicationDefinition", description="Test Managed Application Definition", authorization=[{ "service_principal_id": current.object_id, "role_definition_id": "a094b430-dad3-424d-ae58-13f72fd72591", }])
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
authorizations (pulumi.Input[list]) – One or more
authorizationblock defined below.create_ui_definition (pulumi.Input[str]) – Specifies the
createUiDefinitionjson for the backing template withMicrosoft.Solutions/applicationsresource.description (pulumi.Input[str]) – Specifies the managed application definition description.
display_name (pulumi.Input[str]) – Specifies the managed application definition display name.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
lock_level (pulumi.Input[str]) – Specifies the managed application lock level. Valid values include
CanNotDelete,None,ReadOnly. Changing this forces a new resource to be created.main_template (pulumi.Input[str]) – Specifies the inline main template json which has resources to be provisioned.
name (pulumi.Input[str]) – Specifies the name of the Managed Application Definition. Changing this forces a new resource to be created.
package_enabled (pulumi.Input[bool]) – Is the package enabled? Defaults to
true.package_file_uri (pulumi.Input[str]) – Specifies the managed application definition package file Uri.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Managed Application Definition should exist. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
The authorizations object supports the following:
role_definition_id(pulumi.Input[str]) - Specifies a role definition identifier for the provider. This role will define all the permissions that the provider must have on the managed application’s container resource group. This role definition cannot have permission to delete the resource group.service_principal_id(pulumi.Input[str]) - Specifies a service principal identifier for the provider. This is the identity that the provider will use to call ARM to manage the managed application resources.
One or more
authorizationblock defined below.role_definition_id(str) - Specifies a role definition identifier for the provider. This role will define all the permissions that the provider must have on the managed application’s container resource group. This role definition cannot have permission to delete the resource group.service_principal_id(str) - Specifies a service principal identifier for the provider. This is the identity that the provider will use to call ARM to manage the managed application resources.
create_ui_definition: pulumi.Output[str] = None¶Specifies the
createUiDefinitionjson for the backing template withMicrosoft.Solutions/applicationsresource.
description: pulumi.Output[str] = None¶Specifies the managed application definition description.
display_name: pulumi.Output[str] = None¶Specifies the managed application definition display name.
location: pulumi.Output[str] = None¶Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
lock_level: pulumi.Output[str] = None¶Specifies the managed application lock level. Valid values include
CanNotDelete,None,ReadOnly. Changing this forces a new resource to be created.
main_template: pulumi.Output[str] = None¶Specifies the inline main template json which has resources to be provisioned.
name: pulumi.Output[str] = None¶Specifies the name of the Managed Application Definition. Changing this forces a new resource to be created.
package_enabled: pulumi.Output[bool] = None¶Is the package enabled? Defaults to
true.
package_file_uri: pulumi.Output[str] = None¶Specifies the managed application definition package file Uri.
resource_group_name: pulumi.Output[str] = None¶The name of the Resource Group where the Managed Application Definition should exist. Changing this forces a new resource to be created.
A mapping of tags to assign to the resource.
- static
get(resource_name, id, opts=None, authorizations=None, create_ui_definition=None, description=None, display_name=None, location=None, lock_level=None, main_template=None, name=None, package_enabled=None, package_file_uri=None, resource_group_name=None, tags=None)¶ Get an existing Definition 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.
authorizations (pulumi.Input[list]) – One or more
authorizationblock defined below.create_ui_definition (pulumi.Input[str]) – Specifies the
createUiDefinitionjson for the backing template withMicrosoft.Solutions/applicationsresource.description (pulumi.Input[str]) – Specifies the managed application definition description.
display_name (pulumi.Input[str]) – Specifies the managed application definition display name.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
lock_level (pulumi.Input[str]) – Specifies the managed application lock level. Valid values include
CanNotDelete,None,ReadOnly. Changing this forces a new resource to be created.main_template (pulumi.Input[str]) – Specifies the inline main template json which has resources to be provisioned.
name (pulumi.Input[str]) – Specifies the name of the Managed Application Definition. Changing this forces a new resource to be created.
package_enabled (pulumi.Input[bool]) – Is the package enabled? Defaults to
true.package_file_uri (pulumi.Input[str]) – Specifies the managed application definition package file Uri.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Managed Application Definition should exist. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
The authorizations object supports the following:
role_definition_id(pulumi.Input[str]) - Specifies a role definition identifier for the provider. This role will define all the permissions that the provider must have on the managed application’s container resource group. This role definition cannot have permission to delete the resource group.service_principal_id(pulumi.Input[str]) - Specifies a service principal identifier for the provider. This is the identity that the provider will use to call ARM to manage the managed application resources.
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.managedapplication.GetDefinitionResult(id=None, location=None, name=None, resource_group_name=None)¶ A collection of values returned by getDefinition.
id= None¶The provider-assigned unique ID for this managed resource.
pulumi_azure.managedapplication.get_definition(name=None, resource_group_name=None, opts=None)¶Uses this data source to access information about an existing Managed Application Definition.
import pulumi import pulumi_azure as azure example = azure.managedapplication.get_definition(name="example-managedappdef", resource_group_name="example-resources") pulumi.export("id", example.id)
- Parameters
name (str) – Specifies the name of the Managed Application Definition.
resource_group_name (str) – Specifies the name of the Resource Group where this Managed Application Definition exists.