Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Power Platform
  4. API Docs
  5. EnvironmentSettings
Viewing docs for Power Platform v0.3.3
published on Monday, May 18, 2026 by rpothin
Schema (JSON)
rpothin/pulumi-powerplatform

powerplatform.EnvironmentSettings

powerplatform logo
Viewing docs for Power Platform v0.3.3
published on Monday, May 18, 2026 by rpothin
Schema (JSON)
rpothin/pulumi-powerplatform

    Manages settings on a Power Platform environment. Settings are applied via PATCH to the BAP admin API. Deletion removes the resource from Pulumi state only (settings cannot be unset).

    Create EnvironmentSettings Resource

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

    Constructor syntax

    new EnvironmentSettings(name: string, args: EnvironmentSettingsArgs, opts?: CustomResourceOptions);
    @overload
def EnvironmentSettings(resource_name: str,
                        args: EnvironmentSettingsArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def EnvironmentSettings(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        environment_id: Optional[str] = None,
                        is_read_audit_enabled: Optional[bool] = None,
                        audit_retention_period_in_days: Optional[int] = None,
                        allow_microsoft_trusted_service_tags: Optional[bool] = None,
                        is_activity_logging_enabled: Optional[str] = None,
                        is_audit_enabled: Optional[str] = None,
                        allow_application_user_access: Optional[bool] = None,
                        is_user_access_audit_enabled: Optional[str] = None,
                        max_upload_file_size: Optional[str] = None,
                        plugin_trace_log_setting: Optional[str] = None,
                        power_apps_component_framework_for_canvas_apps: Optional[bool] = None,
                        reverse_proxy_ip_addresses: Optional[str] = None,
                        show_dashboard_cards_in_expanded_state: Optional[bool] = None)
    func NewEnvironmentSettings(ctx *Context, name string, args EnvironmentSettingsArgs, opts ...ResourceOption) (*EnvironmentSettings, error)
    public EnvironmentSettings(string name, EnvironmentSettingsArgs args, CustomResourceOptions? opts = null)
    public EnvironmentSettings(String name, EnvironmentSettingsArgs args)
public EnvironmentSettings(String name, EnvironmentSettingsArgs args, CustomResourceOptions options)

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


    resource "powerplatform_environmentsettings" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EnvironmentSettingsArgs
    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 EnvironmentSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var environmentSettingsResource = new Powerplatform.EnvironmentSettings("environmentSettingsResource", new()
{
    EnvironmentId = "string",
    IsReadAuditEnabled = false,
    AuditRetentionPeriodInDays = 0,
    AllowMicrosoftTrustedServiceTags = false,
    IsActivityLoggingEnabled = "string",
    IsAuditEnabled = "string",
    AllowApplicationUserAccess = false,
    IsUserAccessAuditEnabled = "string",
    MaxUploadFileSize = "string",
    PluginTraceLogSetting = "string",
    PowerAppsComponentFrameworkForCanvasApps = false,
    ReverseProxyIpAddresses = "string",
    ShowDashboardCardsInExpandedState = false,
});

    example, err := powerplatform.NewEnvironmentSettings(ctx, "environmentSettingsResource", &powerplatform.EnvironmentSettingsArgs{
	EnvironmentId:                            pulumi.String("string"),
	IsReadAuditEnabled:                       pulumi.Bool(false),
	AuditRetentionPeriodInDays:               pulumi.Int(0),
	AllowMicrosoftTrustedServiceTags:         pulumi.Bool(false),
	IsActivityLoggingEnabled:                 pulumi.String("string"),
	IsAuditEnabled:                           pulumi.String("string"),
	AllowApplicationUserAccess:               pulumi.Bool(false),
	IsUserAccessAuditEnabled:                 pulumi.String("string"),
	MaxUploadFileSize:                        pulumi.String("string"),
	PluginTraceLogSetting:                    pulumi.String("string"),
	PowerAppsComponentFrameworkForCanvasApps: pulumi.Bool(false),
	ReverseProxyIpAddresses:                  pulumi.String("string"),
	ShowDashboardCardsInExpandedState:        pulumi.Bool(false),
})

    resource "powerplatform_environmentsettings" "environmentSettingsResource" {
  environment_id                                 = "string"
  is_read_audit_enabled                          = false
  audit_retention_period_in_days                 = 0
  allow_microsoft_trusted_service_tags           = false
  is_activity_logging_enabled                    = "string"
  is_audit_enabled                               = "string"
  allow_application_user_access                  = false
  is_user_access_audit_enabled                   = "string"
  max_upload_file_size                           = "string"
  plugin_trace_log_setting                       = "string"
  power_apps_component_framework_for_canvas_apps = false
  reverse_proxy_ip_addresses                     = "string"
  show_dashboard_cards_in_expanded_state         = false
}

    var environmentSettingsResource = new EnvironmentSettings("environmentSettingsResource", EnvironmentSettingsArgs.builder()
    .environmentId("string")
    .isReadAuditEnabled(false)
    .auditRetentionPeriodInDays(0)
    .allowMicrosoftTrustedServiceTags(false)
    .isActivityLoggingEnabled("string")
    .isAuditEnabled("string")
    .allowApplicationUserAccess(false)
    .isUserAccessAuditEnabled("string")
    .maxUploadFileSize("string")
    .pluginTraceLogSetting("string")
    .powerAppsComponentFrameworkForCanvasApps(false)
    .reverseProxyIpAddresses("string")
    .showDashboardCardsInExpandedState(false)
    .build());

    environment_settings_resource = powerplatform.EnvironmentSettings("environmentSettingsResource",
    environment_id="string",
    is_read_audit_enabled=False,
    audit_retention_period_in_days=0,
    allow_microsoft_trusted_service_tags=False,
    is_activity_logging_enabled="string",
    is_audit_enabled="string",
    allow_application_user_access=False,
    is_user_access_audit_enabled="string",
    max_upload_file_size="string",
    plugin_trace_log_setting="string",
    power_apps_component_framework_for_canvas_apps=False,
    reverse_proxy_ip_addresses="string",
    show_dashboard_cards_in_expanded_state=False)

    const environmentSettingsResource = new powerplatform.EnvironmentSettings("environmentSettingsResource", {
    environmentId: "string",
    isReadAuditEnabled: false,
    auditRetentionPeriodInDays: 0,
    allowMicrosoftTrustedServiceTags: false,
    isActivityLoggingEnabled: "string",
    isAuditEnabled: "string",
    allowApplicationUserAccess: false,
    isUserAccessAuditEnabled: "string",
    maxUploadFileSize: "string",
    pluginTraceLogSetting: "string",
    powerAppsComponentFrameworkForCanvasApps: false,
    reverseProxyIpAddresses: "string",
    showDashboardCardsInExpandedState: false,
});

    type: powerplatform:EnvironmentSettings
properties:
    allowApplicationUserAccess: false
    allowMicrosoftTrustedServiceTags: false
    auditRetentionPeriodInDays: 0
    environmentId: string
    isActivityLoggingEnabled: string
    isAuditEnabled: string
    isReadAuditEnabled: false
    isUserAccessAuditEnabled: string
    maxUploadFileSize: string
    pluginTraceLogSetting: string
    powerAppsComponentFrameworkForCanvasApps: false
    reverseProxyIpAddresses: string
    showDashboardCardsInExpandedState: false

    EnvironmentSettings 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 EnvironmentSettings resource accepts the following input properties:

    EnvironmentId string
    The ID of the environment to manage settings for. Immutable after creation.
    AllowApplicationUserAccess bool
    Whether service principal (application user) access is allowed.
    AllowMicrosoftTrustedServiceTags bool
    Whether Microsoft trusted Azure service tags are allowed for connectivity.
    AuditRetentionPeriodInDays int
    Audit log retention period in days. Use -1 for forever, or a value between 31 and 24855.
    IsActivityLoggingEnabled string
    Whether activity logging is enabled (true or false).
    IsAuditEnabled string
    Whether auditing is enabled (true or false).
    IsReadAuditEnabled bool
    Whether read auditing is enabled (GDPR). Managed via Dataverse organizations table.
    IsUserAccessAuditEnabled string
    Whether user access auditing is enabled (true or false).
    MaxUploadFileSize string
    Maximum file upload size in bytes.
    PluginTraceLogSetting string
    Plugin trace log setting (Off, Exception, All).
    PowerAppsComponentFrameworkForCanvasApps bool
    Whether Power Apps Component Framework (PCF) controls are enabled for canvas apps.
    ReverseProxyIpAddresses string
    Comma-separated list of allowed reverse proxy IP addresses or CIDR ranges.
    ShowDashboardCardsInExpandedState bool
    Whether dashboard cards are shown in expanded state by default.
    EnvironmentId string
    The ID of the environment to manage settings for. Immutable after creation.
    AllowApplicationUserAccess bool
    Whether service principal (application user) access is allowed.
    AllowMicrosoftTrustedServiceTags bool
    Whether Microsoft trusted Azure service tags are allowed for connectivity.
    AuditRetentionPeriodInDays int
    Audit log retention period in days. Use -1 for forever, or a value between 31 and 24855.
    IsActivityLoggingEnabled string
    Whether activity logging is enabled (true or false).
    IsAuditEnabled string
    Whether auditing is enabled (true or false).
    IsReadAuditEnabled bool
    Whether read auditing is enabled (GDPR). Managed via Dataverse organizations table.
    IsUserAccessAuditEnabled string
    Whether user access auditing is enabled (true or false).
    MaxUploadFileSize string
    Maximum file upload size in bytes.
    PluginTraceLogSetting string
    Plugin trace log setting (Off, Exception, All).
    PowerAppsComponentFrameworkForCanvasApps bool
    Whether Power Apps Component Framework (PCF) controls are enabled for canvas apps.
    ReverseProxyIpAddresses string
    Comma-separated list of allowed reverse proxy IP addresses or CIDR ranges.
    ShowDashboardCardsInExpandedState bool
    Whether dashboard cards are shown in expanded state by default.
    environment_id string
    The ID of the environment to manage settings for. Immutable after creation.
    allow_application_user_access bool
    Whether service principal (application user) access is allowed.
    allow_microsoft_trusted_service_tags bool
    Whether Microsoft trusted Azure service tags are allowed for connectivity.
    audit_retention_period_in_days number
    Audit log retention period in days. Use -1 for forever, or a value between 31 and 24855.
    is_activity_logging_enabled string
    Whether activity logging is enabled (true or false).
    is_audit_enabled string
    Whether auditing is enabled (true or false).
    is_read_audit_enabled bool
    Whether read auditing is enabled (GDPR). Managed via Dataverse organizations table.
    is_user_access_audit_enabled string
    Whether user access auditing is enabled (true or false).
    max_upload_file_size string
    Maximum file upload size in bytes.
    plugin_trace_log_setting string
    Plugin trace log setting (Off, Exception, All).
    power_apps_component_framework_for_canvas_apps bool
    Whether Power Apps Component Framework (PCF) controls are enabled for canvas apps.
    reverse_proxy_ip_addresses string
    Comma-separated list of allowed reverse proxy IP addresses or CIDR ranges.
    show_dashboard_cards_in_expanded_state bool
    Whether dashboard cards are shown in expanded state by default.
    environmentId String
    The ID of the environment to manage settings for. Immutable after creation.
    allowApplicationUserAccess Boolean
    Whether service principal (application user) access is allowed.
    allowMicrosoftTrustedServiceTags Boolean
    Whether Microsoft trusted Azure service tags are allowed for connectivity.
    auditRetentionPeriodInDays Integer
    Audit log retention period in days. Use -1 for forever, or a value between 31 and 24855.
    isActivityLoggingEnabled String
    Whether activity logging is enabled (true or false).
    isAuditEnabled String
    Whether auditing is enabled (true or false).
    isReadAuditEnabled Boolean
    Whether read auditing is enabled (GDPR). Managed via Dataverse organizations table.
    isUserAccessAuditEnabled String
    Whether user access auditing is enabled (true or false).
    maxUploadFileSize String
    Maximum file upload size in bytes.
    pluginTraceLogSetting String
    Plugin trace log setting (Off, Exception, All).
    powerAppsComponentFrameworkForCanvasApps Boolean
    Whether Power Apps Component Framework (PCF) controls are enabled for canvas apps.
    reverseProxyIpAddresses String
    Comma-separated list of allowed reverse proxy IP addresses or CIDR ranges.
    showDashboardCardsInExpandedState Boolean
    Whether dashboard cards are shown in expanded state by default.
    environmentId string
    The ID of the environment to manage settings for. Immutable after creation.
    allowApplicationUserAccess boolean
    Whether service principal (application user) access is allowed.
    allowMicrosoftTrustedServiceTags boolean
    Whether Microsoft trusted Azure service tags are allowed for connectivity.
    auditRetentionPeriodInDays number
    Audit log retention period in days. Use -1 for forever, or a value between 31 and 24855.
    isActivityLoggingEnabled string
    Whether activity logging is enabled (true or false).
    isAuditEnabled string
    Whether auditing is enabled (true or false).
    isReadAuditEnabled boolean
    Whether read auditing is enabled (GDPR). Managed via Dataverse organizations table.
    isUserAccessAuditEnabled string
    Whether user access auditing is enabled (true or false).
    maxUploadFileSize string
    Maximum file upload size in bytes.
    pluginTraceLogSetting string
    Plugin trace log setting (Off, Exception, All).
    powerAppsComponentFrameworkForCanvasApps boolean
    Whether Power Apps Component Framework (PCF) controls are enabled for canvas apps.
    reverseProxyIpAddresses string
    Comma-separated list of allowed reverse proxy IP addresses or CIDR ranges.
    showDashboardCardsInExpandedState boolean
    Whether dashboard cards are shown in expanded state by default.
    environment_id str
    The ID of the environment to manage settings for. Immutable after creation.
    allow_application_user_access bool
    Whether service principal (application user) access is allowed.
    allow_microsoft_trusted_service_tags bool
    Whether Microsoft trusted Azure service tags are allowed for connectivity.
    audit_retention_period_in_days int
    Audit log retention period in days. Use -1 for forever, or a value between 31 and 24855.
    is_activity_logging_enabled str
    Whether activity logging is enabled (true or false).
    is_audit_enabled str
    Whether auditing is enabled (true or false).
    is_read_audit_enabled bool
    Whether read auditing is enabled (GDPR). Managed via Dataverse organizations table.
    is_user_access_audit_enabled str
    Whether user access auditing is enabled (true or false).
    max_upload_file_size str
    Maximum file upload size in bytes.
    plugin_trace_log_setting str
    Plugin trace log setting (Off, Exception, All).
    power_apps_component_framework_for_canvas_apps bool
    Whether Power Apps Component Framework (PCF) controls are enabled for canvas apps.
    reverse_proxy_ip_addresses str
    Comma-separated list of allowed reverse proxy IP addresses or CIDR ranges.
    show_dashboard_cards_in_expanded_state bool
    Whether dashboard cards are shown in expanded state by default.
    environmentId String
    The ID of the environment to manage settings for. Immutable after creation.
    allowApplicationUserAccess Boolean
    Whether service principal (application user) access is allowed.
    allowMicrosoftTrustedServiceTags Boolean
    Whether Microsoft trusted Azure service tags are allowed for connectivity.
    auditRetentionPeriodInDays Number
    Audit log retention period in days. Use -1 for forever, or a value between 31 and 24855.
    isActivityLoggingEnabled String
    Whether activity logging is enabled (true or false).
    isAuditEnabled String
    Whether auditing is enabled (true or false).
    isReadAuditEnabled Boolean
    Whether read auditing is enabled (GDPR). Managed via Dataverse organizations table.
    isUserAccessAuditEnabled String
    Whether user access auditing is enabled (true or false).
    maxUploadFileSize String
    Maximum file upload size in bytes.
    pluginTraceLogSetting String
    Plugin trace log setting (Off, Exception, All).
    powerAppsComponentFrameworkForCanvasApps Boolean
    Whether Power Apps Component Framework (PCF) controls are enabled for canvas apps.
    reverseProxyIpAddresses String
    Comma-separated list of allowed reverse proxy IP addresses or CIDR ranges.
    showDashboardCardsInExpandedState Boolean
    Whether dashboard cards are shown in expanded state by default.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial