powerplatform.components.ResTenantSettings

Power Platform v0.4.1, Jun 15 26

Viewing docs for Power Platform v0.4.1
published on Monday, Jun 15, 2026 by rpothin

Schema (JSON)

rpothin/pulumi-powerplatform

Viewing docs for Power Platform v0.4.1
published on Monday, Jun 15, 2026 by rpothin

Schema (JSON)

rpothin/pulumi-powerplatform

Composes a single ``powerplatform:components:TenantSettings`` child resource
with an opinionated, AVM-compatible interface.

.. important::
    ``TenantSettings`` is a singleton resource — only one exists per AAD
    tenant.  Assign ownership of this component to a single, dedicated
    infrastructure stack to avoid conflicts.

Example (Python)::

    import rpothin_powerplatform as pp

    tenant_cfg = pp.components.ResTenantSettings(
        "tenant-settings",
        pp.components.ResTenantSettingsArgs(
            disable_environment_creation_by_non_admin_users=True,
            disable_trial_environment_creation_by_non_admin_users=True,
        ),
    )

Create ResTenantSettings Resource

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

Constructor syntax

new ResTenantSettings(name: string, args?: ResTenantSettingsArgs, opts?: ComponentResourceOptions);

@overload
def ResTenantSettings(resource_name: str,
                      args: Optional[ResTenantSettingsArgs] = None,
                      opts: Optional[ResourceOptions] = None)

@overload
def ResTenantSettings(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      disable_capacity_allocation_by_environment_admins: Optional[bool] = None,
                      disable_environment_creation_by_non_admin_users: Optional[bool] = None,
                      disable_newsletter_sendout: Optional[bool] = None,
                      disable_nps_comments_reachout: Optional[bool] = None,
                      disable_portals_creation_by_non_admin_users: Optional[bool] = None,
                      disable_support_tickets_visible_by_all_users: Optional[bool] = None,
                      disable_survey_feedback: Optional[bool] = None,
                      disable_trial_environment_creation_by_non_admin_users: Optional[bool] = None,
                      enable_telemetry: Optional[bool] = None,
                      power_platform: Optional[Mapping[str, Any]] = None,
                      walk_me_opt_out: Optional[bool] = None)

func NewResTenantSettings(ctx *Context, name string, args *ResTenantSettingsArgs, opts ...ResourceOption) (*ResTenantSettings, error)

public ResTenantSettings(string name, ResTenantSettingsArgs? args = null, ComponentResourceOptions? opts = null)

public ResTenantSettings(String name, ResTenantSettingsArgs args)
public ResTenantSettings(String name, ResTenantSettingsArgs args, ComponentResourceOptions options)

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

resource "powerplatform_components_restenantsettings" "name" {
    # resource properties
}

Parameters

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

name string: The unique name of the resource.
args ResTenantSettingsArgs: The arguments to resource properties.
opts ComponentResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ResTenantSettingsArgs: 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 resTenantSettingsResource = new Powerplatform.Components.ResTenantSettings("resTenantSettingsResource", new()
{
    DisableCapacityAllocationByEnvironmentAdmins = false,
    DisableEnvironmentCreationByNonAdminUsers = false,
    DisableNewsletterSendout = false,
    DisableNpsCommentsReachout = false,
    DisablePortalsCreationByNonAdminUsers = false,
    DisableSupportTicketsVisibleByAllUsers = false,
    DisableSurveyFeedback = false,
    DisableTrialEnvironmentCreationByNonAdminUsers = false,
    EnableTelemetry = false,
    PowerPlatform = 
    {
        { "string", "any" },
    },
    WalkMeOptOut = false,
});

example, err := components.NewResTenantSettings(ctx, "resTenantSettingsResource", &components.ResTenantSettingsArgs{
	DisableCapacityAllocationByEnvironmentAdmins:   false,
	DisableEnvironmentCreationByNonAdminUsers:      false,
	DisableNewsletterSendout:                       false,
	DisableNpsCommentsReachout:                     false,
	DisablePortalsCreationByNonAdminUsers:          false,
	DisableSupportTicketsVisibleByAllUsers:         false,
	DisableSurveyFeedback:                          false,
	DisableTrialEnvironmentCreationByNonAdminUsers: false,
	EnableTelemetry:                                false,
	PowerPlatform: map[string]interface{}{
		"string": "any",
	},
	WalkMeOptOut: false,
})

resource "powerplatform_components_restenantsettings" "resTenantSettingsResource" {
  disable_capacity_allocation_by_environment_admins     = false
  disable_environment_creation_by_non_admin_users       = false
  disable_newsletter_sendout                            = false
  disable_nps_comments_reachout                         = false
  disable_portals_creation_by_non_admin_users           = false
  disable_support_tickets_visible_by_all_users          = false
  disable_survey_feedback                               = false
  disable_trial_environment_creation_by_non_admin_users = false
  enable_telemetry                                      = false
  power_platform = {
    "string" = "any"
  }
  walk_me_opt_out = false
}

var resTenantSettingsResource = new ResTenantSettings("resTenantSettingsResource", ResTenantSettingsArgs.builder()
    .disableCapacityAllocationByEnvironmentAdmins(false)
    .disableEnvironmentCreationByNonAdminUsers(false)
    .disableNewsletterSendout(false)
    .disableNpsCommentsReachout(false)
    .disablePortalsCreationByNonAdminUsers(false)
    .disableSupportTicketsVisibleByAllUsers(false)
    .disableSurveyFeedback(false)
    .disableTrialEnvironmentCreationByNonAdminUsers(false)
    .enableTelemetry(false)
    .powerPlatform(Map.of("string", "any"))
    .walkMeOptOut(false)
    .build());

res_tenant_settings_resource = powerplatform.components.ResTenantSettings("resTenantSettingsResource",
    disable_capacity_allocation_by_environment_admins=False,
    disable_environment_creation_by_non_admin_users=False,
    disable_newsletter_sendout=False,
    disable_nps_comments_reachout=False,
    disable_portals_creation_by_non_admin_users=False,
    disable_support_tickets_visible_by_all_users=False,
    disable_survey_feedback=False,
    disable_trial_environment_creation_by_non_admin_users=False,
    enable_telemetry=False,
    power_platform={
        "string": "any",
    },
    walk_me_opt_out=False)

const resTenantSettingsResource = new powerplatform.components.ResTenantSettings("resTenantSettingsResource", {
    disableCapacityAllocationByEnvironmentAdmins: false,
    disableEnvironmentCreationByNonAdminUsers: false,
    disableNewsletterSendout: false,
    disableNpsCommentsReachout: false,
    disablePortalsCreationByNonAdminUsers: false,
    disableSupportTicketsVisibleByAllUsers: false,
    disableSurveyFeedback: false,
    disableTrialEnvironmentCreationByNonAdminUsers: false,
    enableTelemetry: false,
    powerPlatform: {
        string: "any",
    },
    walkMeOptOut: false,
});

type: powerplatform:components:ResTenantSettings
properties:
    disableCapacityAllocationByEnvironmentAdmins: false
    disableEnvironmentCreationByNonAdminUsers: false
    disableNewsletterSendout: false
    disableNpsCommentsReachout: false
    disablePortalsCreationByNonAdminUsers: false
    disableSupportTicketsVisibleByAllUsers: false
    disableSurveyFeedback: false
    disableTrialEnvironmentCreationByNonAdminUsers: false
    enableTelemetry: false
    powerPlatform:
        string: any
    walkMeOptOut: false

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

DisableCapacityAllocationByEnvironmentAdmins bool
DisableEnvironmentCreationByNonAdminUsers bool
DisableNewsletterSendout bool
DisableNpsCommentsReachout bool
DisablePortalsCreationByNonAdminUsers bool
DisableSupportTicketsVisibleByAllUsers bool
DisableSurveyFeedback bool
DisableTrialEnvironmentCreationByNonAdminUsers bool
EnableTelemetry bool
PowerPlatform Dictionary<string, object>
WalkMeOptOut bool

DisableCapacityAllocationByEnvironmentAdmins bool
DisableEnvironmentCreationByNonAdminUsers bool
DisableNewsletterSendout bool
DisableNpsCommentsReachout bool
DisablePortalsCreationByNonAdminUsers bool
DisableSupportTicketsVisibleByAllUsers bool
DisableSurveyFeedback bool
DisableTrialEnvironmentCreationByNonAdminUsers bool
EnableTelemetry bool
PowerPlatform map[string]interface{}
WalkMeOptOut bool

disable_capacity_allocation_by_environment_admins bool
disable_environment_creation_by_non_admin_users bool
disable_newsletter_sendout bool
disable_nps_comments_reachout bool
disable_portals_creation_by_non_admin_users bool
disable_support_tickets_visible_by_all_users bool
disable_survey_feedback bool
disable_trial_environment_creation_by_non_admin_users bool
enable_telemetry bool
power_platform map(any)
walk_me_opt_out bool

disableCapacityAllocationByEnvironmentAdmins Boolean
disableEnvironmentCreationByNonAdminUsers Boolean
disableNewsletterSendout Boolean
disableNpsCommentsReachout Boolean
disablePortalsCreationByNonAdminUsers Boolean
disableSupportTicketsVisibleByAllUsers Boolean
disableSurveyFeedback Boolean
disableTrialEnvironmentCreationByNonAdminUsers Boolean
enableTelemetry Boolean
powerPlatform Map<String,Object>
walkMeOptOut Boolean

disableCapacityAllocationByEnvironmentAdmins boolean
disableEnvironmentCreationByNonAdminUsers boolean
disableNewsletterSendout boolean
disableNpsCommentsReachout boolean
disablePortalsCreationByNonAdminUsers boolean
disableSupportTicketsVisibleByAllUsers boolean
disableSurveyFeedback boolean
disableTrialEnvironmentCreationByNonAdminUsers boolean
enableTelemetry boolean
powerPlatform {[key: string]: any}
walkMeOptOut boolean

disable_capacity_allocation_by_environment_admins bool
disable_environment_creation_by_non_admin_users bool
disable_newsletter_sendout bool
disable_nps_comments_reachout bool
disable_portals_creation_by_non_admin_users bool
disable_support_tickets_visible_by_all_users bool
disable_survey_feedback bool
disable_trial_environment_creation_by_non_admin_users bool
enable_telemetry bool
power_platform Mapping[str, Any]
walk_me_opt_out bool

disableCapacityAllocationByEnvironmentAdmins Boolean
disableEnvironmentCreationByNonAdminUsers Boolean
disableNewsletterSendout Boolean
disableNpsCommentsReachout Boolean
disablePortalsCreationByNonAdminUsers Boolean
disableSupportTicketsVisibleByAllUsers Boolean
disableSurveyFeedback Boolean
disableTrialEnvironmentCreationByNonAdminUsers Boolean
enableTelemetry Boolean
powerPlatform Map<Any>
walkMeOptOut Boolean

Outputs

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