Remove-B1APIKey¶
SYNOPSIS¶
Removes a BloxOne Cloud API Key
SYNTAX¶
Default¶
Remove-B1APIKey -Name <Object> [-User <Object>] [-Type <Object>] [-State <Object>] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
With ID¶
DESCRIPTION¶
This function is used to remove an API Key from the BloxOne Cloud The API Key must be disabled prior to deleting
EXAMPLES¶
EXAMPLE 1¶
EXAMPLE 2¶
PARAMETERS¶
-Name¶
Filter the results by the name of the API Key
Type: Object
Parameter Sets: Default
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-User¶
Filter the results by user_email
Type: Object
Parameter Sets: Default
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Type¶
Filter the results by the API Key Type
Type: Object
Parameter Sets: Default
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-State¶
Filter the results by the state of the API Key
Type: Object
Parameter Sets: Default
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-id¶
The id of the API Key. Accepts pipeline input
Type: String
Parameter Sets: With ID
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Force¶
Perform the operation without prompting for confirmation. By default, this function will always prompt for confirmation unless -Confirm:$false or -Force is specified, or $ConfirmPreference is set to None.
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.