Get-SubnetHistoricalUsage
Retrieves the historical network usage of the subnet backing an enterprise policy, identified by Azure Resource Manager (ARM) resource ID, linked environment, or system ID.
Syntax
BySystemId (Default)
Get-SubnetHistoricalUsage
-SystemId <String>
-TenantId <String>
-Region <String>
[-Endpoint <PPEndpoint>]
[-AzureEnvironment <AzureEnvironment>]
[-ForceAuth]
[<CommonParameters>]
ByEnterprisePolicyId
Get-SubnetHistoricalUsage
-EnterprisePolicyId <String>
-TenantId <String>
-Region <String>
[-Endpoint <PPEndpoint>]
[-AzureEnvironment <AzureEnvironment>]
[-ForceAuth]
[<CommonParameters>]
ByEnvironmentId
Get-SubnetHistoricalUsage
-EnvironmentId <String>
-TenantId <String>
-Region <String>
[-Endpoint <PPEndpoint>]
[-AzureEnvironment <AzureEnvironment>]
[-ForceAuth]
[<CommonParameters>]
Description
Retrieves the historical usage of the subnet backing a subnet injection enterprise policy. This includes usage from all environments linked to the policy and the IP addresses reserved by Azure.
The policy can be identified in three ways:
- By its Azure ARM resource ID (-EnterprisePolicyId). The policy is looked up via ARM and its systemId is resolved automatically.
- By a Power Platform environment ID (-EnvironmentId). The cmdlet finds the policy linked to the environment and resolves its systemId.
- By the policy's system ID GUID directly (-SystemId).
Examples
EXAMPLE 1
Get-SubnetHistoricalUsage -SystemId "00000000-0000-0000-0000-000000000000" -TenantId "00000000-0000-0000-0000-000000000000" -Region "westus"
Retrieves the historical subnet usage using the policy's system ID directly.
EXAMPLE 2
Get-SubnetHistoricalUsage -EnterprisePolicyId "/subscriptions/aaaabbbb-0000-cccc-1111-dddd2222eeee/resourceGroups/myRg/providers/Microsoft.PowerPlatform/enterprisePolicies/myPolicy" -TenantId "00000000-0000-0000-0000-000000000000" -Region "westus"
Retrieves the historical subnet usage by looking up the policy from its ARM resource ID.
EXAMPLE 3
Get-SubnetHistoricalUsage -EnvironmentId "00000000-0000-0000-0000-000000000000" -TenantId "00000000-0000-0000-0000-000000000000" -Region "westus"
Retrieves the historical subnet usage for the policy linked to the specified environment.
EXAMPLE 4
Get-SubnetHistoricalUsage -SystemId "00000000-0000-0000-0000-000000000000" -TenantId "00000000-0000-0000-0000-000000000000" -Region "usgovvirginia" -Endpoint usgovhigh
Retrieves the historical subnet usage for a policy in the US Government High cloud.
Parameters
-AzureEnvironment
The Azure environment to use.
Parameter properties
| Type: | AzureEnvironment |
| Default value: | AzureCloud |
| Accepted values: | AzureCloud, AzureChinaCloud, AzureUSGovernment, EastUs2Euap, CentralUSEuap |
| 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 |
-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: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnterprisePolicyId
The Azure ARM resource ID of the enterprise policy.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByEnterprisePolicyId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnvironmentId
The Power Platform environment ID whose linked policy to use.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByEnvironmentId
| Position: | Named |
| 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 tenant belongs to.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SystemId
The enterprise policy system ID (GUID).
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BySystemId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TenantId
The id of the tenant.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| 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.