1. Packages
  2. Avi Provider
  3. API Docs
  4. getAvailabilityzone
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.getAvailabilityzone

Explore with Pulumi AI

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “AVI: avi.Availabilityzone” sidebar_current: “docs-avi-datasource-availabilityzone” description: |- Get information of Avi AvailabilityZone.

avi.Availabilityzone

This data source is used to to get avi.Availabilityzone objects.

Example Usage

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

const fooAvailabilityzone = avi.getAvailabilityzone({
    cloudRef: "/api/cloud/?tenant=admin&name=Default-Cloud",
    name: "foo",
    uuid: "availabilityzone-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});
Copy
import pulumi
import pulumi_avi as avi

foo_availabilityzone = avi.get_availabilityzone(cloud_ref="/api/cloud/?tenant=admin&name=Default-Cloud",
    name="foo",
    uuid="availabilityzone-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupAvailabilityzone(ctx, &avi.LookupAvailabilityzoneArgs{
			CloudRef: pulumi.StringRef("/api/cloud/?tenant=admin&name=Default-Cloud"),
			Name:     pulumi.StringRef("foo"),
			Uuid:     pulumi.StringRef("availabilityzone-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooAvailabilityzone = Avi.GetAvailabilityzone.Invoke(new()
    {
        CloudRef = "/api/cloud/?tenant=admin&name=Default-Cloud",
        Name = "foo",
        Uuid = "availabilityzone-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetAvailabilityzoneArgs;
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 fooAvailabilityzone = AviFunctions.getAvailabilityzone(GetAvailabilityzoneArgs.builder()
            .cloudRef("/api/cloud/?tenant=admin&name=Default-Cloud")
            .name("foo")
            .uuid("availabilityzone-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}
Copy
variables:
  fooAvailabilityzone:
    fn::invoke:
      function: avi:getAvailabilityzone
      arguments:
        cloudRef: /api/cloud/?tenant=admin&name=Default-Cloud
        name: foo
        uuid: availabilityzone-f9cf6b3e-a411-436f-95e2-2982ba2b217b
Copy

Using getAvailabilityzone

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 getAvailabilityzone(args: GetAvailabilityzoneArgs, opts?: InvokeOptions): Promise<GetAvailabilityzoneResult>
function getAvailabilityzoneOutput(args: GetAvailabilityzoneOutputArgs, opts?: InvokeOptions): Output<GetAvailabilityzoneResult>
Copy
def get_availabilityzone(cloud_ref: Optional[str] = None,
                         id: Optional[str] = None,
                         name: Optional[str] = None,
                         tenant_ref: Optional[str] = None,
                         uuid: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAvailabilityzoneResult
def get_availabilityzone_output(cloud_ref: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         tenant_ref: Optional[pulumi.Input[str]] = None,
                         uuid: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAvailabilityzoneResult]
Copy
func LookupAvailabilityzone(ctx *Context, args *LookupAvailabilityzoneArgs, opts ...InvokeOption) (*LookupAvailabilityzoneResult, error)
func LookupAvailabilityzoneOutput(ctx *Context, args *LookupAvailabilityzoneOutputArgs, opts ...InvokeOption) LookupAvailabilityzoneResultOutput
Copy

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

public static class GetAvailabilityzone 
{
    public static Task<GetAvailabilityzoneResult> InvokeAsync(GetAvailabilityzoneArgs args, InvokeOptions? opts = null)
    public static Output<GetAvailabilityzoneResult> Invoke(GetAvailabilityzoneInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAvailabilityzoneResult> getAvailabilityzone(GetAvailabilityzoneArgs args, InvokeOptions options)
public static Output<GetAvailabilityzoneResult> getAvailabilityzone(GetAvailabilityzoneArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: avi:index/getAvailabilityzone:getAvailabilityzone
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CloudRef string
Search AvailabilityZone by cloud_ref.
Id string
Name string
Search AvailabilityZone by name.
TenantRef string
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Search AvailabilityZone by uuid.
CloudRef string
Search AvailabilityZone by cloud_ref.
Id string
Name string
Search AvailabilityZone by name.
TenantRef string
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Search AvailabilityZone by uuid.
cloudRef String
Search AvailabilityZone by cloud_ref.
id String
name String
Search AvailabilityZone by name.
tenantRef String
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Search AvailabilityZone by uuid.
cloudRef string
Search AvailabilityZone by cloud_ref.
id string
name string
Search AvailabilityZone by name.
tenantRef string
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Search AvailabilityZone by uuid.
cloud_ref str
Search AvailabilityZone by cloud_ref.
id str
name str
Search AvailabilityZone by name.
tenant_ref str
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Search AvailabilityZone by uuid.
cloudRef String
Search AvailabilityZone by cloud_ref.
id String
name String
Search AvailabilityZone by name.
tenantRef String
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Search AvailabilityZone by uuid.

getAvailabilityzone Result

The following output properties are available:

AzClusters List<GetAvailabilityzoneAzCluster>
Group of clusters belongs to the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
AzDatastores List<GetAvailabilityzoneAzDatastore>
Datastores associated with the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
CloudRef string
Availability zone belongs to cloud. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<GetAvailabilityzoneConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
Name string
Availabilty zone where vcenter list belongs to. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Availability zone config uuid. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AzClusters []GetAvailabilityzoneAzCluster
Group of clusters belongs to the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
AzDatastores []GetAvailabilityzoneAzDatastore
Datastores associated with the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
CloudRef string
Availability zone belongs to cloud. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []GetAvailabilityzoneConfigpbAttribute
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
Name string
Availabilty zone where vcenter list belongs to. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Availability zone config uuid. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
azClusters List<GetAvailabilityzoneAzCluster>
Group of clusters belongs to the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
azDatastores List<GetAvailabilityzoneAzDatastore>
Datastores associated with the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
cloudRef String
Availability zone belongs to cloud. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<GetAvailabilityzoneConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
name String
Availabilty zone where vcenter list belongs to. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Availability zone config uuid. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
azClusters GetAvailabilityzoneAzCluster[]
Group of clusters belongs to the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
azDatastores GetAvailabilityzoneAzDatastore[]
Datastores associated with the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
cloudRef string
Availability zone belongs to cloud. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes GetAvailabilityzoneConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
name string
Availabilty zone where vcenter list belongs to. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Availability zone config uuid. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
az_clusters Sequence[GetAvailabilityzoneAzCluster]
Group of clusters belongs to the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
az_datastores Sequence[GetAvailabilityzoneAzDatastore]
Datastores associated with the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
cloud_ref str
Availability zone belongs to cloud. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[GetAvailabilityzoneConfigpbAttribute]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
name str
Availabilty zone where vcenter list belongs to. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Availability zone config uuid. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
azClusters List<Property Map>
Group of clusters belongs to the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
azDatastores List<Property Map>
Datastores associated with the az. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
cloudRef String
Availability zone belongs to cloud. It is a reference to an object of type cloud. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
name String
Availabilty zone where vcenter list belongs to. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
Availabilityzone belongs to tenant. It is a reference to an object of type tenant. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Availability zone config uuid. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Supporting Types

GetAvailabilityzoneAzCluster

ClusterIds This property is required. List<string>
VcenterRef This property is required. string
ClusterIds This property is required. []string
VcenterRef This property is required. string
clusterIds This property is required. List<String>
vcenterRef This property is required. String
clusterIds This property is required. string[]
vcenterRef This property is required. string
cluster_ids This property is required. Sequence[str]
vcenter_ref This property is required. str
clusterIds This property is required. List<String>
vcenterRef This property is required. String

GetAvailabilityzoneAzDatastore

DsIds This property is required. List<string>
Include This property is required. string
DsIds This property is required. []string
Include This property is required. string
dsIds This property is required. List<String>
include This property is required. String
dsIds This property is required. string[]
include This property is required. string
ds_ids This property is required. Sequence[str]
include This property is required. str
dsIds This property is required. List<String>
include This property is required. String

GetAvailabilityzoneConfigpbAttribute

Version This property is required. string
Version This property is required. string
version This property is required. String
version This property is required. string
version This property is required. str
version This property is required. String

Package Details

Repository
avi vmware/terraform-provider-avi
License
Notes
This Pulumi package is based on the avi Terraform Provider.