Edgegrid credentials

Synopsis

Retrieve EdgeGrid credentials.

Syntax

Get-EdgegridCredentials [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

This function will load EdgeGrid credentials by checking for environment variables AKAMAI_HOST, AKAMAI_CLIENT_TOKEN, etc.) or your .edgerc file. These can then be used to sign requests, or be saved to a file with Export-EdgeGridCredentials. If you specify an .edgerc file, that will be tried directly. If not, we check environment variables first, then the default edgerc file location ~/.edgerc), finally throwing an error if no credentials can be found.

If you specify a -Section parameter, we will check for environment variables with that value as a prefix, e.g. -Section MyCreds will instruct the function to look for AKAMAI_MYCREDS_HOST and so on.

Parameters

‑AccountSwitchKey

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

User Guide: Overview