Connect-DomeneshopAccount¶
SYNOPSIS¶
Stores Domeneshop API credentials in a secure context.
SYNTAX¶
__AllParameterSets¶
Connect-DomeneshopAccount [-Token] <string> [[-Secret] <Object>] [[-Context] <string>] [-Default]
[-PassThru] [-WhatIf] [-Confirm]
ALIASES¶
This cmdlet has the following aliases, {{Insert list of aliases}}
DESCRIPTION¶
Stores Domeneshop API credentials using the Context module. The first stored context becomes the default automatically, and Default replaces an existing default. When Secret is omitted, opens the Domeneshop API settings page and securely prompts for it.
EXAMPLES¶
EXAMPLE 1¶
Connect-DomeneshopAccount -Token 'my-token' -Secret (Read-Host -AsSecureString)
Store credentials in the default named context.
EXAMPLE 2¶
Connect-DomeneshopAccount -Token 'my-token'
Open the Domeneshop API settings page and securely prompt for the API secret.
PARAMETERS¶
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Context¶
The name used to store and retrieve this credential context.
Type: System.String
DefaultValue: default
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 2
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Default¶
Replace the default context; the first stored context becomes the default automatically.
Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-PassThru¶
Emit the stored context after it is saved.
Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Secret¶
The Domeneshop API secret as a string or secure string.
Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Key
ParameterSets:
- Name: (All)
Position: 1
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Token¶
The Domeneshop API token used as the Basic authentication username.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 0
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-WhatIf¶
Runs the command in a mode that only reports what would happen without performing the actions.
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
None¶
You can't pipe objects to Connect-DomeneshopAccount.
{{ Fill in the Description }}
OUTPUTS¶
System.Object¶
The stored context when PassThru is specified.
{{ Fill in the Description }}
System.Object¶
{{ Fill in the Description }}
NOTES¶
Credentials are encrypted by the Context module.