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

powerplatform.getEnvironments

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

    Retrieves a list of Power Platform environments available for the authenticated user.

    Using getEnvironments

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEnvironments(args: GetEnvironmentsArgs, opts?: InvokeOptions): Promise<GetEnvironmentsResult>
function getEnvironmentsOutput(args: GetEnvironmentsOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentsResult>
    def get_environments(filter: Optional[str] = None,
                     top: Optional[int] = None,
                     opts: Optional[InvokeOptions] = None) -> GetEnvironmentsResult
def get_environments_output(filter: pulumi.Input[Optional[str]] = None,
                     top: pulumi.Input[Optional[int]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentsResult]
    func GetEnvironments(ctx *Context, args *GetEnvironmentsArgs, opts ...InvokeOption) (*GetEnvironmentsResult, error)
func GetEnvironmentsOutput(ctx *Context, args *GetEnvironmentsOutputArgs, opts ...InvokeOption) GetEnvironmentsResultOutput

    > Note: This function is named GetEnvironments in the Go SDK.

    public static class GetEnvironments 
{
    public static Task<GetEnvironmentsResult> InvokeAsync(GetEnvironmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentsResult> Invoke(GetEnvironmentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEnvironmentsResult> getEnvironments(GetEnvironmentsArgs args, InvokeOptions options)
public static Output<GetEnvironmentsResult> getEnvironments(GetEnvironmentsArgs args, InvokeOptions options)

    fn::invoke:
  function: powerplatform:getEnvironments
  arguments:
    # arguments dictionary
    data "powerplatform_getenvironments" "name" {
    # arguments
}

    The following arguments are supported:

    Filter string
    An OData filter expression. Supported properties: dataverseId, type, geo, state, environmentGroupId, domainName.
    Top int
    Maximum number of environments to return.
    Filter string
    An OData filter expression. Supported properties: dataverseId, type, geo, state, environmentGroupId, domainName.
    Top int
    Maximum number of environments to return.
    filter string
    An OData filter expression. Supported properties: dataverseId, type, geo, state, environmentGroupId, domainName.
    top number
    Maximum number of environments to return.
    filter String
    An OData filter expression. Supported properties: dataverseId, type, geo, state, environmentGroupId, domainName.
    top Integer
    Maximum number of environments to return.
    filter string
    An OData filter expression. Supported properties: dataverseId, type, geo, state, environmentGroupId, domainName.
    top number
    Maximum number of environments to return.
    filter str
    An OData filter expression. Supported properties: dataverseId, type, geo, state, environmentGroupId, domainName.
    top int
    Maximum number of environments to return.
    filter String
    An OData filter expression. Supported properties: dataverseId, type, geo, state, environmentGroupId, domainName.
    top Number
    Maximum number of environments to return.

    getEnvironments Result

    The following output properties are available:

    Environments List<EnvironmentSummary>
    The list of environments.
    Environments []EnvironmentSummary
    The list of environments.
    environments list(object)
    The list of environments.
    environments List<EnvironmentSummary>
    The list of environments.
    environments EnvironmentSummary[]
    The list of environments.
    environments List<Property Map>
    The list of environments.

    Supporting Types

    EnvironmentSummary

    AzureRegion string
    The Azure region of the environment.
    DataverseId string
    The Dataverse organization ID.
    DisplayName string
    The display name of the environment.
    DomainName string
    The domain name of the Dataverse database.
    EnvironmentGroupId string
    The environment group to which this environment belongs.
    Geo string
    The geographical region of the environment.
    Id string
    The unique identifier of the environment.
    SecurityGroupId string
    The security group that controls access.
    State string
    The current state of the environment.
    TenantId string
    The tenant that the environment belongs to.
    Type string
    The type (SKU) of the environment.
    Url string
    The URL of the Dataverse database.
    Version string
    The version of the Dataverse database.
    AzureRegion string
    The Azure region of the environment.
    DataverseId string
    The Dataverse organization ID.
    DisplayName string
    The display name of the environment.
    DomainName string
    The domain name of the Dataverse database.
    EnvironmentGroupId string
    The environment group to which this environment belongs.
    Geo string
    The geographical region of the environment.
    Id string
    The unique identifier of the environment.
    SecurityGroupId string
    The security group that controls access.
    State string
    The current state of the environment.
    TenantId string
    The tenant that the environment belongs to.
    Type string
    The type (SKU) of the environment.
    Url string
    The URL of the Dataverse database.
    Version string
    The version of the Dataverse database.
    azure_region string
    The Azure region of the environment.
    dataverse_id string
    The Dataverse organization ID.
    display_name string
    The display name of the environment.
    domain_name string
    The domain name of the Dataverse database.
    environment_group_id string
    The environment group to which this environment belongs.
    geo string
    The geographical region of the environment.
    id string
    The unique identifier of the environment.
    security_group_id string
    The security group that controls access.
    state string
    The current state of the environment.
    tenant_id string
    The tenant that the environment belongs to.
    type string
    The type (SKU) of the environment.
    url string
    The URL of the Dataverse database.
    version string
    The version of the Dataverse database.
    azureRegion String
    The Azure region of the environment.
    dataverseId String
    The Dataverse organization ID.
    displayName String
    The display name of the environment.
    domainName String
    The domain name of the Dataverse database.
    environmentGroupId String
    The environment group to which this environment belongs.
    geo String
    The geographical region of the environment.
    id String
    The unique identifier of the environment.
    securityGroupId String
    The security group that controls access.
    state String
    The current state of the environment.
    tenantId String
    The tenant that the environment belongs to.
    type String
    The type (SKU) of the environment.
    url String
    The URL of the Dataverse database.
    version String
    The version of the Dataverse database.
    azureRegion string
    The Azure region of the environment.
    dataverseId string
    The Dataverse organization ID.
    displayName string
    The display name of the environment.
    domainName string
    The domain name of the Dataverse database.
    environmentGroupId string
    The environment group to which this environment belongs.
    geo string
    The geographical region of the environment.
    id string
    The unique identifier of the environment.
    securityGroupId string
    The security group that controls access.
    state string
    The current state of the environment.
    tenantId string
    The tenant that the environment belongs to.
    type string
    The type (SKU) of the environment.
    url string
    The URL of the Dataverse database.
    version string
    The version of the Dataverse database.
    azure_region str
    The Azure region of the environment.
    dataverse_id str
    The Dataverse organization ID.
    display_name str
    The display name of the environment.
    domain_name str
    The domain name of the Dataverse database.
    environment_group_id str
    The environment group to which this environment belongs.
    geo str
    The geographical region of the environment.
    id str
    The unique identifier of the environment.
    security_group_id str
    The security group that controls access.
    state str
    The current state of the environment.
    tenant_id str
    The tenant that the environment belongs to.
    type str
    The type (SKU) of the environment.
    url str
    The URL of the Dataverse database.
    version str
    The version of the Dataverse database.
    azureRegion String
    The Azure region of the environment.
    dataverseId String
    The Dataverse organization ID.
    displayName String
    The display name of the environment.
    domainName String
    The domain name of the Dataverse database.
    environmentGroupId String
    The environment group to which this environment belongs.
    geo String
    The geographical region of the environment.
    id String
    The unique identifier of the environment.
    securityGroupId String
    The security group that controls access.
    state String
    The current state of the environment.
    tenantId String
    The tenant that the environment belongs to.
    type String
    The type (SKU) of the environment.
    url String
    The URL of the Dataverse database.
    version String
    The version of the Dataverse database.

    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