1. Packages
  2. DNSimple Provider
  3. API Docs
  4. getZone
DNSimple v5.0.1 published on Friday, Jan 9, 2026 by Pulumi
dnsimple logo
DNSimple v5.0.1 published on Friday, Jan 9, 2026 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as dnsimple from "@pulumi/dnsimple";
    
    const example = dnsimple.getZone({
        name: "example.com",
    });
    
    import pulumi
    import pulumi_dnsimple as dnsimple
    
    example = dnsimple.get_zone(name="example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dnsimple.LookupZone(ctx, &dnsimple.LookupZoneArgs{
    			Name: "example.com",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DNSimple = Pulumi.DNSimple;
    
    return await Deployment.RunAsync(() => 
    {
        var example = DNSimple.GetZone.Invoke(new()
        {
            Name = "example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.dnsimple.DnsimpleFunctions;
    import com.pulumi.dnsimple.inputs.GetZoneArgs;
    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 example = DnsimpleFunctions.getZone(GetZoneArgs.builder()
                .name("example.com")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: dnsimple:getZone
          arguments:
            name: example.com
    

    Using getZone

    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 getZone(args: GetZoneArgs, opts?: InvokeOptions): Promise<GetZoneResult>
    function getZoneOutput(args: GetZoneOutputArgs, opts?: InvokeOptions): Output<GetZoneResult>
    def get_zone(name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetZoneResult
    def get_zone_output(name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetZoneResult]
    func LookupZone(ctx *Context, args *LookupZoneArgs, opts ...InvokeOption) (*LookupZoneResult, error)
    func LookupZoneOutput(ctx *Context, args *LookupZoneOutputArgs, opts ...InvokeOption) LookupZoneResultOutput

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

    public static class GetZone 
    {
        public static Task<GetZoneResult> InvokeAsync(GetZoneArgs args, InvokeOptions? opts = null)
        public static Output<GetZoneResult> Invoke(GetZoneInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetZoneResult> getZone(GetZoneArgs args, InvokeOptions options)
    public static Output<GetZoneResult> getZone(GetZoneArgs args, InvokeOptions options)
    
    fn::invoke:
      function: dnsimple:index/getZone:getZone
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the zone.
    Name string
    The name of the zone.
    name String
    The name of the zone.
    name string
    The name of the zone.
    name str
    The name of the zone.
    name String
    The name of the zone.

    getZone Result

    The following output properties are available:

    AccountId int
    The account ID.
    Id int
    The zone ID.
    Name string
    Reverse bool
    Whether the zone is a reverse zone (true) or forward zone (false).
    AccountId int
    The account ID.
    Id int
    The zone ID.
    Name string
    Reverse bool
    Whether the zone is a reverse zone (true) or forward zone (false).
    accountId Integer
    The account ID.
    id Integer
    The zone ID.
    name String
    reverse Boolean
    Whether the zone is a reverse zone (true) or forward zone (false).
    accountId number
    The account ID.
    id number
    The zone ID.
    name string
    reverse boolean
    Whether the zone is a reverse zone (true) or forward zone (false).
    account_id int
    The account ID.
    id int
    The zone ID.
    name str
    reverse bool
    Whether the zone is a reverse zone (true) or forward zone (false).
    accountId Number
    The account ID.
    id Number
    The zone ID.
    name String
    reverse Boolean
    Whether the zone is a reverse zone (true) or forward zone (false).

    Package Details

    Repository
    DNSimple pulumi/pulumi-dnsimple
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dnsimple Terraform Provider.
    dnsimple logo
    DNSimple v5.0.1 published on Friday, Jan 9, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate