getZones

Cloudflare v6.13.0, Jan 21 26

Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleZones = cloudflare.getZones({
    account: {
        id: "id",
        name: "name",
    },
    direction: "desc",
    name: "name",
    order: "status",
    status: "initializing",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_zones = cloudflare.get_zones(account={
        "id": "id",
        "name": "name",
    },
    direction="desc",
    name="name",
    order="status",
    status="initializing")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupZones(ctx, &cloudflare.LookupZonesArgs{
			Account: cloudflare.GetZonesAccount{
				Id:   pulumi.StringRef("id"),
				Name: pulumi.StringRef("name"),
			},
			Direction: pulumi.StringRef("desc"),
			Name:      pulumi.StringRef("name"),
			Order:     pulumi.StringRef("status"),
			Status:    pulumi.StringRef("initializing"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleZones = Cloudflare.GetZones.Invoke(new()
    {
        Account = new Cloudflare.Inputs.GetZonesAccountInputArgs
        {
            Id = "id",
            Name = "name",
        },
        Direction = "desc",
        Name = "name",
        Order = "status",
        Status = "initializing",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetZonesArgs;
import com.pulumi.cloudflare.inputs.GetZonesAccountArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleZones = CloudflareFunctions.getZones(GetZonesArgs.builder()
            .account(GetZonesAccountArgs.builder()
                .id("id")
                .name("name")
                .build())
            .direction("desc")
            .name("name")
            .order("status")
            .status("initializing")
            .build());

    }
}

variables:
  exampleZones:
    fn::invoke:
      function: cloudflare:getZones
      arguments:
        account:
          id: id
          name: name
        direction: desc
        name: name
        order: status
        status: initializing

Using getZones

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getZones(args: GetZonesArgs, opts?: InvokeOptions): Promise<GetZonesResult>
function getZonesOutput(args: GetZonesOutputArgs, opts?: InvokeOptions): Output<GetZonesResult>

def get_zones(account: Optional[GetZonesAccount] = None,
              direction: Optional[str] = None,
              match: Optional[str] = None,
              max_items: Optional[int] = None,
              name: Optional[str] = None,
              order: Optional[str] = None,
              status: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetZonesResult
def get_zones_output(account: Optional[pulumi.Input[GetZonesAccountArgs]] = None,
              direction: Optional[pulumi.Input[str]] = None,
              match: Optional[pulumi.Input[str]] = None,
              max_items: Optional[pulumi.Input[int]] = None,
              name: Optional[pulumi.Input[str]] = None,
              order: Optional[pulumi.Input[str]] = None,
              status: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetZonesResult]

func LookupZones(ctx *Context, args *LookupZonesArgs, opts ...InvokeOption) (*LookupZonesResult, error)
func LookupZonesOutput(ctx *Context, args *LookupZonesOutputArgs, opts ...InvokeOption) LookupZonesResultOutput

> Note: This function is named LookupZones in the Go SDK.

public static class GetZones 
{
    public static Task<GetZonesResult> InvokeAsync(GetZonesArgs args, InvokeOptions? opts = null)
    public static Output<GetZonesResult> Invoke(GetZonesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetZonesResult> getZones(GetZonesArgs args, InvokeOptions options)
public static Output<GetZonesResult> getZones(GetZonesArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getZones:getZones
  arguments:
    # arguments dictionary

The following arguments are supported:

Account GetZonesAccount
Direction string
Match string
MaxItems int
Name string
Order string
Status string

Account GetZonesAccount
Direction string
Match string
MaxItems int
Name string
Order string
Status string

account GetZonesAccount
direction String
match String
maxItems Integer
name String
order String
status String

account GetZonesAccount
direction string
match string
maxItems number
name string
order string
status string

account GetZonesAccount
direction str
match str
max_items int
name str
order str
status str

account Property Map
direction String
match String
maxItems Number
name String
order String
status String

getZones Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Match string
Results List<GetZonesResult>
Account GetZonesAccount
Direction string
MaxItems int
Name string
Order string
Status string

Id string: The provider-assigned unique ID for this managed resource.
Match string
Results []GetZonesResult
Account GetZonesAccount
Direction string
MaxItems int
Name string
Order string
Status string

id String: The provider-assigned unique ID for this managed resource.
match String
results List<GetZonesResult>
account GetZonesAccount
direction String
maxItems Integer
name String
order String
status String

id string: The provider-assigned unique ID for this managed resource.
match string
results GetZonesResult[]
account GetZonesAccount
direction string
maxItems number
name string
order string
status string

id str: The provider-assigned unique ID for this managed resource.
match str
results Sequence[GetZonesResult]
account GetZonesAccount
direction str
max_items int
name str
order str
status str

id String: The provider-assigned unique ID for this managed resource.
match String
results List<Property Map>
account Property Map
direction String
maxItems Number
name String
order String
status String

Supporting Types