Share via

Get-EnvironmentHistoricalUsage

Module:
Microsoft.PowerPlatform.EnterprisePolicies Module

Retrieves the historical network usage of the specified environment.

Syntax

Default (Default) 

Get-EnvironmentHistoricalUsage
    [-EnvironmentId] <String>
    [[-TenantId] <String>]
    [-Region] <String>
    [[-Endpoint] <PPEndpoint>]
    [-ShowDetails]
    [-ForceAuth]
    [<CommonParameters>]

Description

The Get-EnvironmentHistoricalUsage cmdlet retrieves the historical usage of the specified environment. This is only the historical usage that the specified environment has. It doesn't include usage from other environments and it doesn't include any IP addresses that might be reserved by Azure.

Examples

EXAMPLE 1

Get-EnvironmentHistoricalUsage -EnvironmentId "00000000-0000-0000-0000-000000000000" -Region "westus"

Retrieves the historical network usage for the specified environment in the westus region.

EXAMPLE 2

Get-EnvironmentHistoricalUsage -EnvironmentId "00000000-0000-0000-0000-000000000000" -Region "usgovvirginia" -Endpoint usgovhigh -ShowDetails

Retrieves the historical network usage with detailed breakdown for an environment in the US Government High cloud.

Parameters

-Endpoint

The Power Platform endpoint to connect to. Defaults to 'prod'.

Parameter properties

Type:PPEndpoint
Default value:Prod
Accepted values:unknown, tip1, tip2, prod, usgovhigh, dod, china
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnvironmentId

The Id of the environment to get usage for.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceAuth

Force re-authentication to Azure.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Region

The region that the environment belongs to.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ShowDetails

Switch to show detailed usage information.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TenantId

The id of the tenant that the environment belongs to.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

EnvironmentNetworkUsageDocument

A class representing the historical network usage of the environment.