Show / Hide Table of Contents

Invoke-OCIDnsPromoteZoneDnssecKeyVersion

SYNOPSIS

Invokes Dns service - PromoteZoneDnssecKeyVersion operation.

SYNTAX

Default (Default)

Invoke-OCIDnsPromoteZoneDnssecKeyVersion -ZoneId <String> -PromoteZoneDnssecKeyVersionDetails <Oci.DnsService.Models.PromoteZoneDnssecKeyVersionDetails> [-IfMatch <String>] [-IfUnmodifiedSince <String>] [-OpcRetryToken <String>] [-OpcRequestId <String>] [-Scope <Scope>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

StatusParamSet

Invoke-OCIDnsPromoteZoneDnssecKeyVersion -ZoneId <String> -PromoteZoneDnssecKeyVersionDetails <Oci.DnsService.Models.PromoteZoneDnssecKeyVersionDetails> [-IfMatch <String>] [-IfUnmodifiedSince <String>] [-OpcRetryToken <String>] [-OpcRequestId <String>] [-Scope <Scope>] -WaitForStatus <StatusEnum[]> [-WaitIntervalSeconds <Int32>] [-MaxWaitAttempts <Int32>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Promotes a specified DnssecKeyVersion on the zone. If the DnssecKeyVersion identified in the request body is a key signing key (KSK) that is replacing another DnssecKeyVersion, then the old DnssecKeyVersion is scheduled for removal from the zone. For key signing keys (KSKs), you must create the DS record with the new key information before promoting the new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon as its TTL (time to live) expires. For more information, see DNSSEC.

PARAMETERS

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigFile

The path to the config file.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IfMatch

The `If-Match` header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is `*`, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IfUnmodifiedSince

The `If-Unmodified-Since` header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MaxWaitAttempts

Maximum number of attempts to be made until the resource reaches a desired state.

Type: Int32
Parameter Sets: StatusParamSet
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OpcRequestId

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OpcRetryToken

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PromoteZoneDnssecKeyVersionDetails

Details for promoting a `DnssecKeyVersion`.

Type: Oci.DnsService.Models.PromoteZoneDnssecKeyVersionDetails
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Scope

Specifies to operate only on resources that have a matching DNS scope.

Type: Scope
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Global, Private

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WaitForStatus

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state.

Type: StatusEnum[]
Parameter Sets: StatusParamSet
Aliases: None
Accepted values: UnknownEnumValue, Accepted, InProgress, Failed, Succeeded, Canceling, Canceled

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WaitIntervalSeconds

Check every WaitIntervalSeconds to see whether the resource has reached a desired state.

Type: Int32
Parameter Sets: StatusParamSet
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ZoneId

The OCID of the target zone.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.

OUTPUTS

  • Oci.PSModules.Common.Cmdlets.WorkRequest
  • Oci.DnsService.Responses.PromoteZoneDnssecKeyVersionResponse

RELATED LINKS

  • APIReference
  • DotnetSDKAPI
  • OCIModulesDocs
  • OCIServiceConcepts
  • Examples
Back to top Generated by DocFX