ConvertFrom-AzureRegion

March 15, 2023 · View on GitHub

SYNOPSIS

Get a WattTime ba for a given Azure Region

SYNTAX

ConvertFrom-AzureRegion [-Region] <String> [-AuthToken] <String> [<CommonParameters>]

DESCRIPTION

Get a WattTime ba for a given Azure Region via the https://api2.watttime.org/v2/ba-from-loc endpoint

EXAMPLES

EXAMPLE 1

ConvertFrom-AzureRegion -Region westeurope

PARAMETERS

-Region

The Azure Region to get the WattTime ba for

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AuthToken

The authentication token to use for the request

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

INPUTS

OUTPUTS

a string containing the WattTime ba for the given Azure Region

NOTES

A ba is WattTime's term for a balancing authority. A balancing authority is a regional entity that is responsible for maintaining the balance between supply and demand of electricity in a given region. For more information, see https://www.watttime.org/faq
This command, like the module, requires you to be connected to Azure via Connect-AzAccount

https://github.com/cloudyspells/PSWattTime/blob/main/docs/ConvertFrom-AzureRegion.md

https://github.com/cloudyspells/PSWattTime/blob/main/docs/Get-WattTimeAuthToken.md

https://www.watttime.org/api-documentation/#determine-grid-region