New-B1ConnectionProfile¶
SYNOPSIS¶
This function is used to create new BloxOne connection profiles. By default, the new profile will be set as active.
SYNTAX¶
Region¶
New-B1ConnectionProfile -Name <String> -CSPRegion <String> -APIKey <String> [-NoSwitchProfile]
[<CommonParameters>]
URL¶
New-B1ConnectionProfile -Name <String> -CSPUrl <String> -APIKey <String> [-NoSwitchProfile]
[<CommonParameters>]
DESCRIPTION¶
Connection profiles provide a convenient way of saving API Keys for multiple BloxOne Accounts.
These can then easily be switched between by using Switch-B1ConnectionProfile.
EXAMPLES¶
EXAMPLE 1¶
EXAMPLE 2¶
PARAMETERS¶
-Name¶
Specify the name for the new connection profile
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CSPRegion¶
Optionally configure the the CSP Region to use (i.e EU for the EMEA instance). You only need to use -CSPRegion OR -CSPUrl.
Type: String
Parameter Sets: Region
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CSPUrl¶
Optionally configure the the CSP URL to use manually. You only need to use -CSPUrl OR -CSPRegion.
Type: String
Parameter Sets: URL
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-APIKey¶
Specify the BloxOne API Key to save as part of this profile
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NoSwitchProfile¶
Do not make this profile active upon creation
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.