Synopsis
Import keys
Syntax
body (Default)
Import-APIKey -CollectionID <Int32> -Body <Object> [-EdgeRCFile <String>] [-Section <String>]
[-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
attributes
Import-APIKey -CollectionID <Int32> -KeyValue <String> [-KeyDescription <String>] [-Label <String>]
[-Tags <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
file
Import-APIKey -CollectionID <Int32> [-InputFile <String>] [-EdgeRCFile <String>] [-Section <String>]
[-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Import keys to a given CollectionID.
Keys can be imported from a PSCustomObject (or JSON string), or you can specify -InputFile as either json, csv or xml.
Parameters
-AccountSwitchKey
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account Switch Keys can be found using Get-AccountSwitchKey.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Body
Request body, either as a PSCustomObject or string. This parameter supports pipelining.
Type: Object
Parameter Sets: body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-CollectionID
Identifies the collection.
Run Get-APIKeyCollection to select one.
Type: Int32
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputFile
Local file containing keys.
Must be one of: json, csv or xml.
Type: String
Parameter Sets: file
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-KeyDescription
Description for the key you wish to create.
Type: String
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-KeyValue
Value for the key you wish to create.
Type: String
Parameter Sets: attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Label
Label assigned to the key.
Type: String
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags
Comma-separated string containing additional categories assigned to the key that you can use as filters.
Type: String
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
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
System.Object
Outputs
System.Object