1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudRegion
Viewing docs for OVHCloud v2.15.0
published on Monday, Jun 29, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.15.0
published on Monday, Jun 29, 2026 by OVHcloud

    Use this data source to retrieve information about a single region of a public cloud project, using the OVHcloud API v2.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const region = ovh.getCloudRegion({
        serviceName: "<public cloud project ID>",
        name: "GRA11",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    region = ovh.get_cloud_region(service_name="<public cloud project ID>",
        name="GRA11")
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ovh.GetCloudRegion(ctx, &ovh.GetCloudRegionArgs{
    			ServiceName: "<public cloud project ID>",
    			Name:        "GRA11",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var region = Ovh.GetCloudRegion.Invoke(new()
        {
            ServiceName = "<public cloud project ID>",
            Name = "GRA11",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.OvhFunctions;
    import com.pulumi.ovh.inputs.GetCloudRegionArgs;
    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 region = OvhFunctions.getCloudRegion(GetCloudRegionArgs.builder()
                .serviceName("<public cloud project ID>")
                .name("GRA11")
                .build());
    
        }
    }
    
    variables:
      region:
        fn::invoke:
          function: ovh:getCloudRegion
          arguments:
            serviceName: <public cloud project ID>
            name: GRA11
    
    Example coming soon!
    

    Using getCloudRegion

    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 getCloudRegion(args: GetCloudRegionArgs, opts?: InvokeOptions): Promise<GetCloudRegionResult>
    function getCloudRegionOutput(args: GetCloudRegionOutputArgs, opts?: InvokeOptions): Output<GetCloudRegionResult>
    def get_cloud_region(name: Optional[str] = None,
                         service_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCloudRegionResult
    def get_cloud_region_output(name: pulumi.Input[Optional[str]] = None,
                         service_name: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCloudRegionResult]
    func GetCloudRegion(ctx *Context, args *GetCloudRegionArgs, opts ...InvokeOption) (*GetCloudRegionResult, error)
    func GetCloudRegionOutput(ctx *Context, args *GetCloudRegionOutputArgs, opts ...InvokeOption) GetCloudRegionResultOutput

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

    public static class GetCloudRegion 
    {
        public static Task<GetCloudRegionResult> InvokeAsync(GetCloudRegionArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudRegionResult> Invoke(GetCloudRegionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudRegionResult> getCloudRegion(GetCloudRegionArgs args, InvokeOptions options)
    public static Output<GetCloudRegionResult> getCloudRegion(GetCloudRegionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ovh:index/getCloudRegion:getCloudRegion
      arguments:
        # arguments dictionary
    data "ovh_getcloudregion" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    The name of the region (e.g. GRA11).
    ServiceName string
    The id of the public cloud project.
    Name string
    The name of the region (e.g. GRA11).
    ServiceName string
    The id of the public cloud project.
    name string
    The name of the region (e.g. GRA11).
    service_name string
    The id of the public cloud project.
    name String
    The name of the region (e.g. GRA11).
    serviceName String
    The id of the public cloud project.
    name string
    The name of the region (e.g. GRA11).
    serviceName string
    The id of the public cloud project.
    name str
    The name of the region (e.g. GRA11).
    service_name str
    The id of the public cloud project.
    name String
    The name of the region (e.g. GRA11).
    serviceName String
    The id of the public cloud project.

    getCloudRegion Result

    The following output properties are available:

    AvailabilityZones List<string>
    Availability zones available in the region.
    Continent string
    Continent code of the region.
    Country string
    Country code of the region.
    DatacenterName string
    Display name of the datacenter hosting the region.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    ServiceName string
    Services List<string>
    Available OpenStack services in the region.
    Status string
    Region status (ENABLED, DISABLED or MAINTENANCE).
    AvailabilityZones []string
    Availability zones available in the region.
    Continent string
    Continent code of the region.
    Country string
    Country code of the region.
    DatacenterName string
    Display name of the datacenter hosting the region.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    ServiceName string
    Services []string
    Available OpenStack services in the region.
    Status string
    Region status (ENABLED, DISABLED or MAINTENANCE).
    availability_zones list(string)
    Availability zones available in the region.
    continent string
    Continent code of the region.
    country string
    Country code of the region.
    datacenter_name string
    Display name of the datacenter hosting the region.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    service_name string
    services list(string)
    Available OpenStack services in the region.
    status string
    Region status (ENABLED, DISABLED or MAINTENANCE).
    availabilityZones List<String>
    Availability zones available in the region.
    continent String
    Continent code of the region.
    country String
    Country code of the region.
    datacenterName String
    Display name of the datacenter hosting the region.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    serviceName String
    services List<String>
    Available OpenStack services in the region.
    status String
    Region status (ENABLED, DISABLED or MAINTENANCE).
    availabilityZones string[]
    Availability zones available in the region.
    continent string
    Continent code of the region.
    country string
    Country code of the region.
    datacenterName string
    Display name of the datacenter hosting the region.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    serviceName string
    services string[]
    Available OpenStack services in the region.
    status string
    Region status (ENABLED, DISABLED or MAINTENANCE).
    availability_zones Sequence[str]
    Availability zones available in the region.
    continent str
    Continent code of the region.
    country str
    Country code of the region.
    datacenter_name str
    Display name of the datacenter hosting the region.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    service_name str
    services Sequence[str]
    Available OpenStack services in the region.
    status str
    Region status (ENABLED, DISABLED or MAINTENANCE).
    availabilityZones List<String>
    Availability zones available in the region.
    continent String
    Continent code of the region.
    country String
    Country code of the region.
    datacenterName String
    Display name of the datacenter hosting the region.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    serviceName String
    services List<String>
    Available OpenStack services in the region.
    status String
    Region status (ENABLED, DISABLED or MAINTENANCE).

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.15.0
    published on Monday, Jun 29, 2026 by OVHcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial