1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCbrZone
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getCbrZone

Explore with Pulumi AI

Provides a read-only data source to retrieve information about a cbr_zone. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

Example Usage

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

const cbrZone = ibm.getCbrZone({
    zoneId: "zone_id",
});
Copy
import pulumi
import pulumi_ibm as ibm

cbr_zone = ibm.get_cbr_zone(zone_id="zone_id")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupCbrZone(ctx, &ibm.LookupCbrZoneArgs{
			ZoneId: "zone_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var cbrZone = Ibm.GetCbrZone.Invoke(new()
    {
        ZoneId = "zone_id",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetCbrZoneArgs;
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 cbrZone = IbmFunctions.getCbrZone(GetCbrZoneArgs.builder()
            .zoneId("zone_id")
            .build());

    }
}
Copy
variables:
  cbrZone:
    fn::invoke:
      function: ibm:getCbrZone
      arguments:
        zoneId: zone_id
Copy

Using getCbrZone

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 getCbrZone(args: GetCbrZoneArgs, opts?: InvokeOptions): Promise<GetCbrZoneResult>
function getCbrZoneOutput(args: GetCbrZoneOutputArgs, opts?: InvokeOptions): Output<GetCbrZoneResult>
Copy
def get_cbr_zone(id: Optional[str] = None,
                 zone_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetCbrZoneResult
def get_cbr_zone_output(id: Optional[pulumi.Input[str]] = None,
                 zone_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetCbrZoneResult]
Copy
func LookupCbrZone(ctx *Context, args *LookupCbrZoneArgs, opts ...InvokeOption) (*LookupCbrZoneResult, error)
func LookupCbrZoneOutput(ctx *Context, args *LookupCbrZoneOutputArgs, opts ...InvokeOption) LookupCbrZoneResultOutput
Copy

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

public static class GetCbrZone 
{
    public static Task<GetCbrZoneResult> InvokeAsync(GetCbrZoneArgs args, InvokeOptions? opts = null)
    public static Output<GetCbrZoneResult> Invoke(GetCbrZoneInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCbrZoneResult> getCbrZone(GetCbrZoneArgs args, InvokeOptions options)
public static Output<GetCbrZoneResult> getCbrZone(GetCbrZoneArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCbrZone:getCbrZone
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ZoneId This property is required. string
The ID of a zone.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-fA-F0-9]{32}$/.
Id string
(String) The globally unique ID of the zone.
ZoneId This property is required. string
The ID of a zone.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-fA-F0-9]{32}$/.
Id string
(String) The globally unique ID of the zone.
zoneId This property is required. String
The ID of a zone.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-fA-F0-9]{32}$/.
id String
(String) The globally unique ID of the zone.
zoneId This property is required. string
The ID of a zone.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-fA-F0-9]{32}$/.
id string
(String) The globally unique ID of the zone.
zone_id This property is required. str
The ID of a zone.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-fA-F0-9]{32}$/.
id str
(String) The globally unique ID of the zone.
zoneId This property is required. String
The ID of a zone.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-fA-F0-9]{32}$/.
id String
(String) The globally unique ID of the zone.

getCbrZone Result

The following output properties are available:

AccountId string
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
AddressCount double
(Integer) The number of addresses in the zone.
Addresses List<GetCbrZoneAddress>
(List) The list of addresses in the zone.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested schema for addresses:
CreatedAt string
(String) The time the resource was created.
CreatedById string
(String) IAM ID of the user or service which created the resource.
Crn string
(String) The zone CRN.
Description string
(String) The description of the zone.

  • Constraints: The maximum length is 300 characters. The minimum length is 0 characters. The value must match regular expression /^[\x20-\xFE]*$/.
ExcludedCount double
(Integer) The number of excluded addresses in the zone.
Excludeds List<GetCbrZoneExcluded>
(List) The list of excluded addresses in the zone. Only addresses of type ipAddress, ipRange, and subnet can be excluded.

  • Constraints: The maximum length is 1000 items. Nested schema for excluded:
Href string
(String) The href link to the resource.
Id string
(String) The globally unique ID of the zone.
LastModifiedAt string
(String) The last time the resource was modified.
LastModifiedById string
(String) IAM ID of the user or service which modified the resource.
Name string
(String) The name of the zone.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 \-_]+$/.
ZoneId string
AccountId string
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
AddressCount float64
(Integer) The number of addresses in the zone.
Addresses []GetCbrZoneAddress
(List) The list of addresses in the zone.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested schema for addresses:
CreatedAt string
(String) The time the resource was created.
CreatedById string
(String) IAM ID of the user or service which created the resource.
Crn string
(String) The zone CRN.
Description string
(String) The description of the zone.

  • Constraints: The maximum length is 300 characters. The minimum length is 0 characters. The value must match regular expression /^[\x20-\xFE]*$/.
ExcludedCount float64
(Integer) The number of excluded addresses in the zone.
Excludeds []GetCbrZoneExcluded
(List) The list of excluded addresses in the zone. Only addresses of type ipAddress, ipRange, and subnet can be excluded.

  • Constraints: The maximum length is 1000 items. Nested schema for excluded:
Href string
(String) The href link to the resource.
Id string
(String) The globally unique ID of the zone.
LastModifiedAt string
(String) The last time the resource was modified.
LastModifiedById string
(String) IAM ID of the user or service which modified the resource.
Name string
(String) The name of the zone.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 \-_]+$/.
ZoneId string
accountId String
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
addressCount Double
(Integer) The number of addresses in the zone.
addresses List<GetCbrZoneAddress>
(List) The list of addresses in the zone.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested schema for addresses:
createdAt String
(String) The time the resource was created.
createdById String
(String) IAM ID of the user or service which created the resource.
crn String
(String) The zone CRN.
description String
(String) The description of the zone.

  • Constraints: The maximum length is 300 characters. The minimum length is 0 characters. The value must match regular expression /^[\x20-\xFE]*$/.
excludedCount Double
(Integer) The number of excluded addresses in the zone.
excludeds List<GetCbrZoneExcluded>
(List) The list of excluded addresses in the zone. Only addresses of type ipAddress, ipRange, and subnet can be excluded.

  • Constraints: The maximum length is 1000 items. Nested schema for excluded:
href String
(String) The href link to the resource.
id String
(String) The globally unique ID of the zone.
lastModifiedAt String
(String) The last time the resource was modified.
lastModifiedById String
(String) IAM ID of the user or service which modified the resource.
name String
(String) The name of the zone.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 \-_]+$/.
zoneId String
accountId string
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
addressCount number
(Integer) The number of addresses in the zone.
addresses GetCbrZoneAddress[]
(List) The list of addresses in the zone.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested schema for addresses:
createdAt string
(String) The time the resource was created.
createdById string
(String) IAM ID of the user or service which created the resource.
crn string
(String) The zone CRN.
description string
(String) The description of the zone.

  • Constraints: The maximum length is 300 characters. The minimum length is 0 characters. The value must match regular expression /^[\x20-\xFE]*$/.
excludedCount number
(Integer) The number of excluded addresses in the zone.
excludeds GetCbrZoneExcluded[]
(List) The list of excluded addresses in the zone. Only addresses of type ipAddress, ipRange, and subnet can be excluded.

  • Constraints: The maximum length is 1000 items. Nested schema for excluded:
href string
(String) The href link to the resource.
id string
(String) The globally unique ID of the zone.
lastModifiedAt string
(String) The last time the resource was modified.
lastModifiedById string
(String) IAM ID of the user or service which modified the resource.
name string
(String) The name of the zone.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 \-_]+$/.
zoneId string
account_id str
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
address_count float
(Integer) The number of addresses in the zone.
addresses Sequence[GetCbrZoneAddress]
(List) The list of addresses in the zone.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested schema for addresses:
created_at str
(String) The time the resource was created.
created_by_id str
(String) IAM ID of the user or service which created the resource.
crn str
(String) The zone CRN.
description str
(String) The description of the zone.

  • Constraints: The maximum length is 300 characters. The minimum length is 0 characters. The value must match regular expression /^[\x20-\xFE]*$/.
excluded_count float
(Integer) The number of excluded addresses in the zone.
excludeds Sequence[GetCbrZoneExcluded]
(List) The list of excluded addresses in the zone. Only addresses of type ipAddress, ipRange, and subnet can be excluded.

  • Constraints: The maximum length is 1000 items. Nested schema for excluded:
href str
(String) The href link to the resource.
id str
(String) The globally unique ID of the zone.
last_modified_at str
(String) The last time the resource was modified.
last_modified_by_id str
(String) IAM ID of the user or service which modified the resource.
name str
(String) The name of the zone.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 \-_]+$/.
zone_id str
accountId String
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
addressCount Number
(Integer) The number of addresses in the zone.
addresses List<Property Map>
(List) The list of addresses in the zone.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested schema for addresses:
createdAt String
(String) The time the resource was created.
createdById String
(String) IAM ID of the user or service which created the resource.
crn String
(String) The zone CRN.
description String
(String) The description of the zone.

  • Constraints: The maximum length is 300 characters. The minimum length is 0 characters. The value must match regular expression /^[\x20-\xFE]*$/.
excludedCount Number
(Integer) The number of excluded addresses in the zone.
excludeds List<Property Map>
(List) The list of excluded addresses in the zone. Only addresses of type ipAddress, ipRange, and subnet can be excluded.

  • Constraints: The maximum length is 1000 items. Nested schema for excluded:
href String
(String) The href link to the resource.
id String
(String) The globally unique ID of the zone.
lastModifiedAt String
(String) The last time the resource was modified.
lastModifiedById String
(String) IAM ID of the user or service which modified the resource.
name String
(String) The name of the zone.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 \-_]+$/.
zoneId String

Supporting Types

GetCbrZoneAddress

Reves This property is required. List<GetCbrZoneAddressRef>
(List) A service reference value. Nested schema for ref:
Type This property is required. string
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
Value This property is required. string
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
Reves This property is required. []GetCbrZoneAddressRef
(List) A service reference value. Nested schema for ref:
Type This property is required. string
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
Value This property is required. string
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
reves This property is required. List<GetCbrZoneAddressRef>
(List) A service reference value. Nested schema for ref:
type This property is required. String
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
value This property is required. String
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
reves This property is required. GetCbrZoneAddressRef[]
(List) A service reference value. Nested schema for ref:
type This property is required. string
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
value This property is required. string
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
reves This property is required. Sequence[GetCbrZoneAddressRef]
(List) A service reference value. Nested schema for ref:
type This property is required. str
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
value This property is required. str
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
reves This property is required. List<Property Map>
(List) A service reference value. Nested schema for ref:
type This property is required. String
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
value This property is required. String
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.

GetCbrZoneAddressRef

AccountId This property is required. string
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
Location This property is required. string
(String) The location.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
ServiceInstance This property is required. string
(String) The service instance.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-/]+$/.
ServiceName This property is required. string
(String) The service name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
ServiceType This property is required. string
(String) The service type.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z_]+$/.
AccountId This property is required. string
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
Location This property is required. string
(String) The location.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
ServiceInstance This property is required. string
(String) The service instance.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-/]+$/.
ServiceName This property is required. string
(String) The service name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
ServiceType This property is required. string
(String) The service type.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z_]+$/.
accountId This property is required. String
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
location This property is required. String
(String) The location.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
serviceInstance This property is required. String
(String) The service instance.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-/]+$/.
serviceName This property is required. String
(String) The service name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
serviceType This property is required. String
(String) The service type.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z_]+$/.
accountId This property is required. string
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
location This property is required. string
(String) The location.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
serviceInstance This property is required. string
(String) The service instance.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-/]+$/.
serviceName This property is required. string
(String) The service name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
serviceType This property is required. string
(String) The service type.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z_]+$/.
account_id This property is required. str
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
location This property is required. str
(String) The location.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
service_instance This property is required. str
(String) The service instance.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-/]+$/.
service_name This property is required. str
(String) The service name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
service_type This property is required. str
(String) The service type.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z_]+$/.
accountId This property is required. String
(String) The id of the account owning the service.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9\-]+$/.
location This property is required. String
(String) The location.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
serviceInstance This property is required. String
(String) The service instance.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-/]+$/.
serviceName This property is required. String
(String) The service name.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z\-]+$/.
serviceType This property is required. String
(String) The service type.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[0-9a-z_]+$/.

GetCbrZoneExcluded

Type This property is required. string
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
Value This property is required. string
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
Type This property is required. string
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
Value This property is required. string
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
type This property is required. String
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
value This property is required. String
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
type This property is required. string
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
value This property is required. string
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
type This property is required. str
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
value This property is required. str
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.
type This property is required. String
(String) The type of address.

  • Constraints: Allowable values are: ipAddress, ipRange, subnet, vpc, serviceRef.
value This property is required. String
(String) The IP address.

  • Constraints: The maximum length is 45 characters. The minimum length is 2 characters. The value must match regular expression /^[a-zA-Z0-9:.]+$/.

Package Details

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