Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Power Platform
  4. API Docs
  5. components
  6. ResEnvironment
Viewing docs for Power Platform v0.4.1
published on Monday, Jun 15, 2026 by rpothin
Schema (JSON)
rpothin/pulumi-powerplatform

powerplatform.components.ResEnvironment

powerplatform logo
Viewing docs for Power Platform v0.4.1
published on Monday, Jun 15, 2026 by rpothin
Schema (JSON)
rpothin/pulumi-powerplatform

    AVM-aligned component that manages a Power Platform environment lifecycle.

    Composes:

* :class:`~rpothin_powerplatform.Environment` — always created.
* :class:`~rpothin_powerplatform.ManagedEnvironment` — when
  ``args.managed_environment_enabled`` is ``True``.
* :class:`~rpothin_powerplatform.EnvironmentSettings` — when any settings
  field is provided.

All child resources inherit the parent component's provider configuration
through ``opts.providers`` / ``opts.provider`` so callers can supply an
explicit provider without repeating it for every child.

    Create ResEnvironment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ResEnvironment(name: string, args: ResEnvironmentArgs, opts?: ComponentResourceOptions);
    @overload
def ResEnvironment(resource_name: str,
                   args: ResEnvironmentArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ResEnvironment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   location: Optional[str] = None,
                   cadence: Optional[str] = None,
                   environment_type: Optional[str] = None,
                   billing_policy_id: Optional[str] = None,
                   allow_bing_search: Optional[bool] = None,
                   dataverse: Optional[DataverseConfigArgs] = None,
                   description: Optional[str] = None,
                   audit_retention_period_in_days: Optional[int] = None,
                   enable_telemetry: Optional[bool] = None,
                   environment_group_id: Optional[str] = None,
                   azure_region: Optional[str] = None,
                   is_audit_enabled: Optional[bool] = None,
                   is_read_audit_enabled: Optional[bool] = None,
                   is_user_access_audit_enabled: Optional[bool] = None,
                   allow_moving_data_across_regions: Optional[bool] = None,
                   managed_environment_enabled: Optional[bool] = None,
                   max_upload_file_size: Optional[str] = None,
                   plugin_trace_log_setting: Optional[str] = None,
                   show_dashboard_cards_in_expanded_state: Optional[bool] = None)
    func NewResEnvironment(ctx *Context, name string, args ResEnvironmentArgs, opts ...ResourceOption) (*ResEnvironment, error)
    public ResEnvironment(string name, ResEnvironmentArgs args, ComponentResourceOptions? opts = null)
    public ResEnvironment(String name, ResEnvironmentArgs args)
public ResEnvironment(String name, ResEnvironmentArgs args, ComponentResourceOptions options)

    type: powerplatform:components:ResEnvironment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "powerplatform_components_resenvironment" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ResEnvironmentArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ResEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ResEnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResEnvironmentArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResEnvironmentArgs
    The arguments to resource properties.
    options ComponentResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var resEnvironmentResource = new Powerplatform.Components.ResEnvironment("resEnvironmentResource", new()
{
    DisplayName = "string",
    Location = "string",
    Cadence = "string",
    EnvironmentType = "string",
    BillingPolicyId = "string",
    AllowBingSearch = false,
    Dataverse = new Powerplatform.Components.Inputs.DataverseConfigArgs
    {
        AdministrationModeEnabled = false,
        BackgroundOperationEnabled = false,
        CurrencyCode = "string",
        Domain = "string",
        LanguageCode = 0,
        SecurityGroupId = "string",
        TemplateMetadata = "string",
        Templates = new()
        {
            "string",
        },
    },
    Description = "string",
    AuditRetentionPeriodInDays = 0,
    EnableTelemetry = false,
    EnvironmentGroupId = "string",
    AzureRegion = "string",
    IsAuditEnabled = false,
    IsReadAuditEnabled = false,
    IsUserAccessAuditEnabled = false,
    AllowMovingDataAcrossRegions = false,
    ManagedEnvironmentEnabled = false,
    MaxUploadFileSize = "string",
    PluginTraceLogSetting = "string",
    ShowDashboardCardsInExpandedState = false,
});

    example, err := components.NewResEnvironment(ctx, "resEnvironmentResource", &components.ResEnvironmentArgs{
	DisplayName:     "string",
	Location:        "string",
	Cadence:         "string",
	EnvironmentType: "string",
	BillingPolicyId: "string",
	AllowBingSearch: false,
	Dataverse: components.DataverseConfigArgs{
		AdministrationModeEnabled:  false,
		BackgroundOperationEnabled: false,
		CurrencyCode:               "string",
		Domain:                     "string",
		LanguageCode:               0,
		SecurityGroupId:            "string",
		TemplateMetadata:           "string",
		Templates: []string{
			"string",
		},
	},
	Description:                       "string",
	AuditRetentionPeriodInDays:        0,
	EnableTelemetry:                   false,
	EnvironmentGroupId:                "string",
	AzureRegion:                       "string",
	IsAuditEnabled:                    false,
	IsReadAuditEnabled:                false,
	IsUserAccessAuditEnabled:          false,
	AllowMovingDataAcrossRegions:      false,
	ManagedEnvironmentEnabled:         false,
	MaxUploadFileSize:                 "string",
	PluginTraceLogSetting:             "string",
	ShowDashboardCardsInExpandedState: false,
})

    resource "powerplatform_components_resenvironment" "resEnvironmentResource" {
  display_name      = "string"
  location          = "string"
  cadence           = "string"
  environment_type  = "string"
  billing_policy_id = "string"
  allow_bing_search = false
  dataverse = {
    administration_mode_enabled  = false
    background_operation_enabled = false
    currency_code                = "string"
    domain                       = "string"
    language_code                = 0
    security_group_id            = "string"
    template_metadata            = "string"
    templates                    = ["string"]
  }
  description                            = "string"
  audit_retention_period_in_days         = 0
  enable_telemetry                       = false
  environment_group_id                   = "string"
  azure_region                           = "string"
  is_audit_enabled                       = false
  is_read_audit_enabled                  = false
  is_user_access_audit_enabled           = false
  allow_moving_data_across_regions       = false
  managed_environment_enabled            = false
  max_upload_file_size                   = "string"
  plugin_trace_log_setting               = "string"
  show_dashboard_cards_in_expanded_state = false
}

    var resEnvironmentResource = new ResEnvironment("resEnvironmentResource", ResEnvironmentArgs.builder()
    .displayName("string")
    .location("string")
    .cadence("string")
    .environmentType("string")
    .billingPolicyId("string")
    .allowBingSearch(false)
    .dataverse(DataverseConfigArgs.builder()
        .administrationModeEnabled(false)
        .backgroundOperationEnabled(false)
        .currencyCode("string")
        .domain("string")
        .languageCode(0)
        .securityGroupId("string")
        .templateMetadata("string")
        .templates("string")
        .build())
    .description("string")
    .auditRetentionPeriodInDays(0)
    .enableTelemetry(false)
    .environmentGroupId("string")
    .azureRegion("string")
    .isAuditEnabled(false)
    .isReadAuditEnabled(false)
    .isUserAccessAuditEnabled(false)
    .allowMovingDataAcrossRegions(false)
    .managedEnvironmentEnabled(false)
    .maxUploadFileSize("string")
    .pluginTraceLogSetting("string")
    .showDashboardCardsInExpandedState(false)
    .build());

    res_environment_resource = powerplatform.components.ResEnvironment("resEnvironmentResource",
    display_name="string",
    location="string",
    cadence="string",
    environment_type="string",
    billing_policy_id="string",
    allow_bing_search=False,
    dataverse={
        "administration_mode_enabled": False,
        "background_operation_enabled": False,
        "currency_code": "string",
        "domain": "string",
        "language_code": 0,
        "security_group_id": "string",
        "template_metadata": "string",
        "templates": ["string"],
    },
    description="string",
    audit_retention_period_in_days=0,
    enable_telemetry=False,
    environment_group_id="string",
    azure_region="string",
    is_audit_enabled=False,
    is_read_audit_enabled=False,
    is_user_access_audit_enabled=False,
    allow_moving_data_across_regions=False,
    managed_environment_enabled=False,
    max_upload_file_size="string",
    plugin_trace_log_setting="string",
    show_dashboard_cards_in_expanded_state=False)

    const resEnvironmentResource = new powerplatform.components.ResEnvironment("resEnvironmentResource", {
    displayName: "string",
    location: "string",
    cadence: "string",
    environmentType: "string",
    billingPolicyId: "string",
    allowBingSearch: false,
    dataverse: {
        administrationModeEnabled: false,
        backgroundOperationEnabled: false,
        currencyCode: "string",
        domain: "string",
        languageCode: 0,
        securityGroupId: "string",
        templateMetadata: "string",
        templates: ["string"],
    },
    description: "string",
    auditRetentionPeriodInDays: 0,
    enableTelemetry: false,
    environmentGroupId: "string",
    azureRegion: "string",
    isAuditEnabled: false,
    isReadAuditEnabled: false,
    isUserAccessAuditEnabled: false,
    allowMovingDataAcrossRegions: false,
    managedEnvironmentEnabled: false,
    maxUploadFileSize: "string",
    pluginTraceLogSetting: "string",
    showDashboardCardsInExpandedState: false,
});

    type: powerplatform:components:ResEnvironment
properties:
    allowBingSearch: false
    allowMovingDataAcrossRegions: false
    auditRetentionPeriodInDays: 0
    azureRegion: string
    billingPolicyId: string
    cadence: string
    dataverse:
        administrationModeEnabled: false
        backgroundOperationEnabled: false
        currencyCode: string
        domain: string
        languageCode: 0
        securityGroupId: string
        templateMetadata: string
        templates:
            - string
    description: string
    displayName: string
    enableTelemetry: false
    environmentGroupId: string
    environmentType: string
    isAuditEnabled: false
    isReadAuditEnabled: false
    isUserAccessAuditEnabled: false
    location: string
    managedEnvironmentEnabled: false
    maxUploadFileSize: string
    pluginTraceLogSetting: string
    showDashboardCardsInExpandedState: false

    ResEnvironment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ResEnvironment resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ResEnvironment resource produces the following output properties:

    Supporting Types

    DataverseConfig, DataverseConfigArgs

    Dataverse provisioning configuration.

    Mirrors the ``var.dataverse`` object in the AVM ``res-environment`` module.
Passing a :class:`DataverseConfig` instance triggers Dataverse provisioning
on the underlying ``Environment`` resource.

    Field names follow the AVM variable names (snake_case).  The component maps
them to the camelCase wire names expected by the Pulumi provider.

    Package Details

    Repository
    powerplatform rpothin/pulumi-powerplatform
    License
    MIT
    powerplatform logo
    Viewing docs for Power Platform v0.4.1
    published on Monday, Jun 15, 2026 by rpothin
    Schema (JSON)
    rpothin/pulumi-powerplatform

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial