New-B1APIKey¶
SYNOPSIS¶
Creates a new BloxOne Cloud API Key
SYNTAX¶
Interactive¶
New-B1APIKey [[-Type] <String>] [-Name] <String> [[-Expires] <DateTime>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Service¶
New-B1APIKey [[-Type] <String>] [-Name] <String> [[-Expires] <DateTime>] [-UserEmail] <String> [-UserName] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
This function is used to create a new API Key from the BloxOne Cloud.
EXAMPLES¶
EXAMPLE 1¶
EXAMPLE 2¶
PARAMETERS¶
-Type¶
The type of API Key to create. Interactive will create a user API Key assigned to your user. Service will create a service API Key assigned to the selected service user.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name¶
The name for the new API Key
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Expires¶
The date/time when the key will expire. Defaults to 1 year.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: $(Get-Date).AddYears(1)
Accept pipeline input: False
Accept wildcard characters: False
DYNAMIC PARAMETERS¶
Info
These parameters are only available when -Type is Service
Warning
The -UserEmail and -UserName parameters are mutually exclusive, with -UserEmail taking preference if both are specified
-UserEmail¶
The UserEmail parameter is used in conjunction with '-Type Service' to specify which user to associate with the key
Type: string
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UserName¶
The UserName parameter is used in conjunction with '-Type Service' to specify which user to associate with the key
Type: string
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force¶
Perform the operation without prompting for confirmation. By default, this function will not prompt for confirmation unless $ConfirmPreference is set to Medium.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
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.