Get-OCIDnsZonesList

SYNOPSIS

Invokes Dns service - ListZones operation.

SYNTAX

Limit

Get-OCIDnsZonesList -CompartmentId <String> [-OpcRequestId <String>] [-Limit <Int64>] [-Page <String>] [-Name <String>] [-NameContains <String>] [-ZoneType <ZoneTypeEnum>] [-TimeCreatedGreaterThanOrEqualTo <DateTime>] [-TimeCreatedLessThan <DateTime>] [-LifecycleState <LifecycleStateEnum>] [-SortBy <SortByEnum>] [-SortOrder <SortOrder>] [-Scope <Scope>] [-ViewId <String>] [-TsigKeyId <String>] [-DnssecState <ZoneDnssecState>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIDnsZonesList -CompartmentId <String> [-OpcRequestId <String>] [-Page <String>] [-Name <String>] [-NameContains <String>] [-ZoneType <ZoneTypeEnum>] [-TimeCreatedGreaterThanOrEqualTo <DateTime>] [-TimeCreatedLessThan <DateTime>] [-LifecycleState <LifecycleStateEnum>] [-SortBy <SortByEnum>] [-SortOrder <SortOrder>] [-Scope <Scope>] [-ViewId <String>] [-TsigKeyId <String>] [-DnssecState <ZoneDnssecState>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Gets a list of all zones in the specified compartment. The collection can be filtered by name, time created, scope, associated view, and zone type. Filtering by view is only supported for private zones.

PARAMETERS

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

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

-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

-CompartmentId

The OCID of the compartment the resource belongs to.

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

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

-DnssecState

Search for zones that have the given `DnssecState`.

Type: ZoneDnssecState
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Enabled, Disabled

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

-LifecycleState

The state of a resource.

Type: LifecycleStateEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Active, Creating, Deleted, Deleting, Failed, Updating

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

-Limit

The maximum number of items to return in a page of the collection.

Type: Int64
Parameter Sets: Limit
Aliases: None

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

-Name

A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value.

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

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

-NameContains

Search by zone name. Will match any zone whose name (case-insensitive) contains the provided value.

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

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

-Page

The value of the `opc-next-page` response header from the previous "List" call.

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

-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

-SortBy

The field by which to sort zones.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Name, ZoneType, TimeCreated

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

-SortOrder

The order to sort the resources.

Type: SortOrder
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

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

-TimeCreatedGreaterThanOrEqualTo

An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.

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

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

-TimeCreatedLessThan

An RFC 3339 timestamp that states all returned resources were created before the indicated time.

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

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

-TsigKeyId

Search for zones that are associated with a TSIG key.

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

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

-ViewId

The OCID of the view the resource is associated with.

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

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

-ZoneType

Search by zone type, `PRIMARY` or `SECONDARY`. Will match any zone whose type equals the provided value.

Type: ZoneTypeEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Primary, Secondary

Required: False
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.DnsService.Models.ZoneSummary
• Oci.DnsService.Responses.ListZonesResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples