1. Packages
  2. OVH
  3. API Docs
  4. Domain
  5. Zone
OVHCloud v1.1.0 published on Thursday, Nov 21, 2024 by OVHcloud

ovh.Domain.Zone

Explore with Pulumi AI

ovh logo
OVHCloud v1.1.0 published on Thursday, Nov 21, 2024 by OVHcloud

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    import * as ovh from "@pulumi/ovh";
    
    const myaccount = ovh.Me.getMe({});
    const mycart = myaccount.then(myaccount => ovh.Order.getCart({
        ovhSubsidiary: myaccount.ovhSubsidiary,
    }));
    const zoneCartProductPlan = mycart.then(mycart => ovh.Order.getCartProductPlan({
        cartId: mycart.id,
        priceCapacity: "renew",
        product: "dns",
        planCode: "zone",
    }));
    const zoneZone = new ovh.domain.Zone("zoneZone", {
        ovhSubsidiary: mycart.then(mycart => mycart.ovhSubsidiary),
        plan: {
            duration: zoneCartProductPlan.then(zoneCartProductPlan => zoneCartProductPlan.selectedPrices?.[0]?.duration),
            planCode: zoneCartProductPlan.then(zoneCartProductPlan => zoneCartProductPlan.planCode),
            pricingMode: zoneCartProductPlan.then(zoneCartProductPlan => zoneCartProductPlan.selectedPrices?.[0]?.pricingMode),
            configurations: [
                {
                    label: "zone",
                    value: "myzone.mydomain.com",
                },
                {
                    label: "template",
                    value: "minimized",
                },
            ],
        },
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    myaccount = ovh.Me.get_me()
    mycart = ovh.Order.get_cart(ovh_subsidiary=myaccount.ovh_subsidiary)
    zone_cart_product_plan = ovh.Order.get_cart_product_plan(cart_id=mycart.id,
        price_capacity="renew",
        product="dns",
        plan_code="zone")
    zone_zone = ovh.domain.Zone("zoneZone",
        ovh_subsidiary=mycart.ovh_subsidiary,
        plan={
            "duration": zone_cart_product_plan.selected_prices[0].duration,
            "plan_code": zone_cart_product_plan.plan_code,
            "pricing_mode": zone_cart_product_plan.selected_prices[0].pricing_mode,
            "configurations": [
                {
                    "label": "zone",
                    "value": "myzone.mydomain.com",
                },
                {
                    "label": "template",
                    "value": "minimized",
                },
            ],
        })
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/go/ovh/Domain"
    	"github.com/ovh/pulumi-ovh/sdk/go/ovh/Me"
    	"github.com/ovh/pulumi-ovh/sdk/go/ovh/Order"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		myaccount, err := Me.GetMe(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		mycart, err := Order.GetCart(ctx, &order.GetCartArgs{
    			OvhSubsidiary: myaccount.OvhSubsidiary,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		zoneCartProductPlan, err := Order.GetCartProductPlan(ctx, &order.GetCartProductPlanArgs{
    			CartId:        mycart.Id,
    			PriceCapacity: "renew",
    			Product:       "dns",
    			PlanCode:      "zone",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = Domain.NewZone(ctx, "zoneZone", &Domain.ZoneArgs{
    			OvhSubsidiary: pulumi.String(mycart.OvhSubsidiary),
    			Plan: &domain.ZonePlanArgs{
    				Duration:    pulumi.String(zoneCartProductPlan.SelectedPrices[0].Duration),
    				PlanCode:    pulumi.String(zoneCartProductPlan.PlanCode),
    				PricingMode: pulumi.String(zoneCartProductPlan.SelectedPrices[0].PricingMode),
    				Configurations: domain.ZonePlanConfigurationArray{
    					&domain.ZonePlanConfigurationArgs{
    						Label: pulumi.String("zone"),
    						Value: pulumi.String("myzone.mydomain.com"),
    					},
    					&domain.ZonePlanConfigurationArgs{
    						Label: pulumi.String("template"),
    						Value: pulumi.String("minimized"),
    					},
    				},
    			},
    		})
    		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 myaccount = Ovh.Me.GetMe.Invoke();
    
        var mycart = Ovh.Order.GetCart.Invoke(new()
        {
            OvhSubsidiary = myaccount.Apply(getMeResult => getMeResult.OvhSubsidiary),
        });
    
        var zoneCartProductPlan = Ovh.Order.GetCartProductPlan.Invoke(new()
        {
            CartId = mycart.Apply(getCartResult => getCartResult.Id),
            PriceCapacity = "renew",
            Product = "dns",
            PlanCode = "zone",
        });
    
        var zoneZone = new Ovh.Domain.Zone("zoneZone", new()
        {
            OvhSubsidiary = mycart.Apply(getCartResult => getCartResult.OvhSubsidiary),
            Plan = new Ovh.Domain.Inputs.ZonePlanArgs
            {
                Duration = zoneCartProductPlan.Apply(getCartProductPlanResult => getCartProductPlanResult.SelectedPrices[0]?.Duration),
                PlanCode = zoneCartProductPlan.Apply(getCartProductPlanResult => getCartProductPlanResult.PlanCode),
                PricingMode = zoneCartProductPlan.Apply(getCartProductPlanResult => getCartProductPlanResult.SelectedPrices[0]?.PricingMode),
                Configurations = new[]
                {
                    new Ovh.Domain.Inputs.ZonePlanConfigurationArgs
                    {
                        Label = "zone",
                        Value = "myzone.mydomain.com",
                    },
                    new Ovh.Domain.Inputs.ZonePlanConfigurationArgs
                    {
                        Label = "template",
                        Value = "minimized",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.Me.MeFunctions;
    import com.pulumi.ovh.Order.OrderFunctions;
    import com.pulumi.ovh.Order.inputs.GetCartArgs;
    import com.pulumi.ovh.Order.inputs.GetCartProductPlanArgs;
    import com.pulumi.ovh.Domain.Zone;
    import com.pulumi.ovh.Domain.ZoneArgs;
    import com.pulumi.ovh.Domain.inputs.ZonePlanArgs;
    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 myaccount = MeFunctions.getMe();
    
            final var mycart = OrderFunctions.getCart(GetCartArgs.builder()
                .ovhSubsidiary(myaccount.applyValue(getMeResult -> getMeResult.ovhSubsidiary()))
                .build());
    
            final var zoneCartProductPlan = OrderFunctions.getCartProductPlan(GetCartProductPlanArgs.builder()
                .cartId(mycart.applyValue(getCartResult -> getCartResult.id()))
                .priceCapacity("renew")
                .product("dns")
                .planCode("zone")
                .build());
    
            var zoneZone = new Zone("zoneZone", ZoneArgs.builder()
                .ovhSubsidiary(mycart.applyValue(getCartResult -> getCartResult.ovhSubsidiary()))
                .plan(ZonePlanArgs.builder()
                    .duration(zoneCartProductPlan.applyValue(getCartProductPlanResult -> getCartProductPlanResult.selectedPrices()[0].duration()))
                    .planCode(zoneCartProductPlan.applyValue(getCartProductPlanResult -> getCartProductPlanResult.planCode()))
                    .pricingMode(zoneCartProductPlan.applyValue(getCartProductPlanResult -> getCartProductPlanResult.selectedPrices()[0].pricingMode()))
                    .configurations(                
                        ZonePlanConfigurationArgs.builder()
                            .label("zone")
                            .value("myzone.mydomain.com")
                            .build(),
                        ZonePlanConfigurationArgs.builder()
                            .label("template")
                            .value("minimized")
                            .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      zoneZone:
        type: ovh:Domain:Zone
        properties:
          ovhSubsidiary: ${mycart.ovhSubsidiary}
          plan:
            duration: ${zoneCartProductPlan.selectedPrices[0].duration}
            planCode: ${zoneCartProductPlan.planCode}
            pricingMode: ${zoneCartProductPlan.selectedPrices[0].pricingMode}
            configurations:
              - label: zone
                value: myzone.mydomain.com
              - label: template
                value: minimized
    variables:
      myaccount:
        fn::invoke:
          Function: ovh:Me:getMe
          Arguments: {}
      mycart:
        fn::invoke:
          Function: ovh:Order:getCart
          Arguments:
            ovhSubsidiary: ${myaccount.ovhSubsidiary}
      zoneCartProductPlan:
        fn::invoke:
          Function: ovh:Order:getCartProductPlan
          Arguments:
            cartId: ${mycart.id}
            priceCapacity: renew
            product: dns
            planCode: zone
    

    Create Zone Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Zone(name: string, args?: ZoneArgs, opts?: CustomResourceOptions);
    @overload
    def Zone(resource_name: str,
             args: Optional[ZoneArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Zone(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             orders: Optional[Sequence[_domain.ZoneOrderArgs]] = None,
             ovh_subsidiary: Optional[str] = None,
             payment_mean: Optional[str] = None,
             plan: Optional[_domain.ZonePlanArgs] = None,
             plan_options: Optional[Sequence[_domain.ZonePlanOptionArgs]] = None)
    func NewZone(ctx *Context, name string, args *ZoneArgs, opts ...ResourceOption) (*Zone, error)
    public Zone(string name, ZoneArgs? args = null, CustomResourceOptions? opts = null)
    public Zone(String name, ZoneArgs args)
    public Zone(String name, ZoneArgs args, CustomResourceOptions options)
    
    type: ovh:Domain:Zone
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var zoneResource = new Ovh.Domain.Zone("zoneResource", new()
    {
        Orders = new[]
        {
            new Ovh.Domain.Inputs.ZoneOrderArgs
            {
                Date = "string",
                Details = new[]
                {
                    new Ovh.Domain.Inputs.ZoneOrderDetailArgs
                    {
                        Description = "string",
                        Domain = "string",
                        OrderDetailId = 0,
                        Quantity = "string",
                    },
                },
                ExpirationDate = "string",
                OrderId = 0,
            },
        },
        OvhSubsidiary = "string",
        Plan = new Ovh.Domain.Inputs.ZonePlanArgs
        {
            Duration = "string",
            PlanCode = "string",
            PricingMode = "string",
            CatalogName = "string",
            Configurations = new[]
            {
                new Ovh.Domain.Inputs.ZonePlanConfigurationArgs
                {
                    Label = "string",
                    Value = "string",
                },
            },
        },
        PlanOptions = new[]
        {
            new Ovh.Domain.Inputs.ZonePlanOptionArgs
            {
                Duration = "string",
                PlanCode = "string",
                PricingMode = "string",
                CatalogName = "string",
                Configurations = new[]
                {
                    new Ovh.Domain.Inputs.ZonePlanOptionConfigurationArgs
                    {
                        Label = "string",
                        Value = "string",
                    },
                },
            },
        },
    });
    
    example, err := Domain.NewZone(ctx, "zoneResource", &Domain.ZoneArgs{
    	Orders: domain.ZoneOrderArray{
    		&domain.ZoneOrderArgs{
    			Date: pulumi.String("string"),
    			Details: domain.ZoneOrderDetailArray{
    				&domain.ZoneOrderDetailArgs{
    					Description:   pulumi.String("string"),
    					Domain:        pulumi.String("string"),
    					OrderDetailId: pulumi.Int(0),
    					Quantity:      pulumi.String("string"),
    				},
    			},
    			ExpirationDate: pulumi.String("string"),
    			OrderId:        pulumi.Int(0),
    		},
    	},
    	OvhSubsidiary: pulumi.String("string"),
    	Plan: &domain.ZonePlanArgs{
    		Duration:    pulumi.String("string"),
    		PlanCode:    pulumi.String("string"),
    		PricingMode: pulumi.String("string"),
    		CatalogName: pulumi.String("string"),
    		Configurations: domain.ZonePlanConfigurationArray{
    			&domain.ZonePlanConfigurationArgs{
    				Label: pulumi.String("string"),
    				Value: pulumi.String("string"),
    			},
    		},
    	},
    	PlanOptions: domain.ZonePlanOptionArray{
    		&domain.ZonePlanOptionArgs{
    			Duration:    pulumi.String("string"),
    			PlanCode:    pulumi.String("string"),
    			PricingMode: pulumi.String("string"),
    			CatalogName: pulumi.String("string"),
    			Configurations: domain.ZonePlanOptionConfigurationArray{
    				&domain.ZonePlanOptionConfigurationArgs{
    					Label: pulumi.String("string"),
    					Value: pulumi.String("string"),
    				},
    			},
    		},
    	},
    })
    
    var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
        .orders(ZoneOrderArgs.builder()
            .date("string")
            .details(ZoneOrderDetailArgs.builder()
                .description("string")
                .domain("string")
                .orderDetailId(0)
                .quantity("string")
                .build())
            .expirationDate("string")
            .orderId(0)
            .build())
        .ovhSubsidiary("string")
        .plan(ZonePlanArgs.builder()
            .duration("string")
            .planCode("string")
            .pricingMode("string")
            .catalogName("string")
            .configurations(ZonePlanConfigurationArgs.builder()
                .label("string")
                .value("string")
                .build())
            .build())
        .planOptions(ZonePlanOptionArgs.builder()
            .duration("string")
            .planCode("string")
            .pricingMode("string")
            .catalogName("string")
            .configurations(ZonePlanOptionConfigurationArgs.builder()
                .label("string")
                .value("string")
                .build())
            .build())
        .build());
    
    zone_resource = ovh.domain.Zone("zoneResource",
        orders=[{
            "date": "string",
            "details": [{
                "description": "string",
                "domain": "string",
                "order_detail_id": 0,
                "quantity": "string",
            }],
            "expiration_date": "string",
            "order_id": 0,
        }],
        ovh_subsidiary="string",
        plan={
            "duration": "string",
            "plan_code": "string",
            "pricing_mode": "string",
            "catalog_name": "string",
            "configurations": [{
                "label": "string",
                "value": "string",
            }],
        },
        plan_options=[{
            "duration": "string",
            "plan_code": "string",
            "pricing_mode": "string",
            "catalog_name": "string",
            "configurations": [{
                "label": "string",
                "value": "string",
            }],
        }])
    
    const zoneResource = new ovh.domain.Zone("zoneResource", {
        orders: [{
            date: "string",
            details: [{
                description: "string",
                domain: "string",
                orderDetailId: 0,
                quantity: "string",
            }],
            expirationDate: "string",
            orderId: 0,
        }],
        ovhSubsidiary: "string",
        plan: {
            duration: "string",
            planCode: "string",
            pricingMode: "string",
            catalogName: "string",
            configurations: [{
                label: "string",
                value: "string",
            }],
        },
        planOptions: [{
            duration: "string",
            planCode: "string",
            pricingMode: "string",
            catalogName: "string",
            configurations: [{
                label: "string",
                value: "string",
            }],
        }],
    });
    
    type: ovh:Domain:Zone
    properties:
        orders:
            - date: string
              details:
                - description: string
                  domain: string
                  orderDetailId: 0
                  quantity: string
              expirationDate: string
              orderId: 0
        ovhSubsidiary: string
        plan:
            catalogName: string
            configurations:
                - label: string
                  value: string
            duration: string
            planCode: string
            pricingMode: string
        planOptions:
            - catalogName: string
              configurations:
                - label: string
                  value: string
              duration: string
              planCode: string
              pricingMode: string
    

    Zone Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Zone resource accepts the following input properties:

    Orders List<ZoneOrder>
    Details about an Order
    OvhSubsidiary string
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    PaymentMean string
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    Plan ZonePlan
    Product Plan to order
    PlanOptions List<ZonePlanOption>
    Product Plan to order
    Orders []ZoneOrderArgs
    Details about an Order
    OvhSubsidiary string
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    PaymentMean string
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    Plan ZonePlanArgs
    Product Plan to order
    PlanOptions []ZonePlanOptionArgs
    Product Plan to order
    orders List<ZoneOrder>
    Details about an Order
    ovhSubsidiary String
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    paymentMean String
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    plan ZonePlan
    Product Plan to order
    planOptions List<ZonePlanOption>
    Product Plan to order
    orders ZoneOrder[]
    Details about an Order
    ovhSubsidiary string
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    paymentMean string
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    plan ZonePlan
    Product Plan to order
    planOptions ZonePlanOption[]
    Product Plan to order
    orders Sequence[domain.ZoneOrderArgs]
    Details about an Order
    ovh_subsidiary str
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    payment_mean str
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    plan domain.ZonePlanArgs
    Product Plan to order
    plan_options Sequence[domain.ZonePlanOptionArgs]
    Product Plan to order
    orders List<Property Map>
    Details about an Order
    ovhSubsidiary String
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    paymentMean String
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    plan Property Map
    Product Plan to order
    planOptions List<Property Map>
    Product Plan to order

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Zone resource produces the following output properties:

    DnssecSupported bool
    Is DNSSEC supported by this zone
    HasDnsAnycast bool
    hasDnsAnycast flag of the DNS zone
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdate string
    Last update date of the DNS zone
    Name string
    Zone name
    NameServers List<string>
    Name servers that host the DNS zone
    ZoneURN string
    DnssecSupported bool
    Is DNSSEC supported by this zone
    HasDnsAnycast bool
    hasDnsAnycast flag of the DNS zone
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdate string
    Last update date of the DNS zone
    Name string
    Zone name
    NameServers []string
    Name servers that host the DNS zone
    ZoneURN string
    ZoneURN String
    dnssecSupported Boolean
    Is DNSSEC supported by this zone
    hasDnsAnycast Boolean
    hasDnsAnycast flag of the DNS zone
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdate String
    Last update date of the DNS zone
    name String
    Zone name
    nameServers List<String>
    Name servers that host the DNS zone
    ZoneURN string
    dnssecSupported boolean
    Is DNSSEC supported by this zone
    hasDnsAnycast boolean
    hasDnsAnycast flag of the DNS zone
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdate string
    Last update date of the DNS zone
    name string
    Zone name
    nameServers string[]
    Name servers that host the DNS zone
    dnssec_supported bool
    Is DNSSEC supported by this zone
    has_dns_anycast bool
    hasDnsAnycast flag of the DNS zone
    id str
    The provider-assigned unique ID for this managed resource.
    last_update str
    Last update date of the DNS zone
    name str
    Zone name
    name_servers Sequence[str]
    Name servers that host the DNS zone
    zone_urn str
    ZoneURN String
    dnssecSupported Boolean
    Is DNSSEC supported by this zone
    hasDnsAnycast Boolean
    hasDnsAnycast flag of the DNS zone
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdate String
    Last update date of the DNS zone
    name String
    Zone name
    nameServers List<String>
    Name servers that host the DNS zone

    Look up Existing Zone Resource

    Get an existing Zone resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ZoneState, opts?: CustomResourceOptions): Zone
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            zone_urn: Optional[str] = None,
            dnssec_supported: Optional[bool] = None,
            has_dns_anycast: Optional[bool] = None,
            last_update: Optional[str] = None,
            name: Optional[str] = None,
            name_servers: Optional[Sequence[str]] = None,
            orders: Optional[Sequence[_domain.ZoneOrderArgs]] = None,
            ovh_subsidiary: Optional[str] = None,
            payment_mean: Optional[str] = None,
            plan: Optional[_domain.ZonePlanArgs] = None,
            plan_options: Optional[Sequence[_domain.ZonePlanOptionArgs]] = None) -> Zone
    func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
    public static Zone Get(string name, Input<string> id, ZoneState? state, CustomResourceOptions? opts = null)
    public static Zone get(String name, Output<String> id, ZoneState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DnssecSupported bool
    Is DNSSEC supported by this zone
    HasDnsAnycast bool
    hasDnsAnycast flag of the DNS zone
    LastUpdate string
    Last update date of the DNS zone
    Name string
    Zone name
    NameServers List<string>
    Name servers that host the DNS zone
    Orders List<ZoneOrder>
    Details about an Order
    OvhSubsidiary string
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    PaymentMean string
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    Plan ZonePlan
    Product Plan to order
    PlanOptions List<ZonePlanOption>
    Product Plan to order
    ZoneURN string
    DnssecSupported bool
    Is DNSSEC supported by this zone
    HasDnsAnycast bool
    hasDnsAnycast flag of the DNS zone
    LastUpdate string
    Last update date of the DNS zone
    Name string
    Zone name
    NameServers []string
    Name servers that host the DNS zone
    Orders []ZoneOrderArgs
    Details about an Order
    OvhSubsidiary string
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    PaymentMean string
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    Plan ZonePlanArgs
    Product Plan to order
    PlanOptions []ZonePlanOptionArgs
    Product Plan to order
    ZoneURN string
    ZoneURN String
    dnssecSupported Boolean
    Is DNSSEC supported by this zone
    hasDnsAnycast Boolean
    hasDnsAnycast flag of the DNS zone
    lastUpdate String
    Last update date of the DNS zone
    name String
    Zone name
    nameServers List<String>
    Name servers that host the DNS zone
    orders List<ZoneOrder>
    Details about an Order
    ovhSubsidiary String
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    paymentMean String
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    plan ZonePlan
    Product Plan to order
    planOptions List<ZonePlanOption>
    Product Plan to order
    ZoneURN string
    dnssecSupported boolean
    Is DNSSEC supported by this zone
    hasDnsAnycast boolean
    hasDnsAnycast flag of the DNS zone
    lastUpdate string
    Last update date of the DNS zone
    name string
    Zone name
    nameServers string[]
    Name servers that host the DNS zone
    orders ZoneOrder[]
    Details about an Order
    ovhSubsidiary string
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    paymentMean string
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    plan ZonePlan
    Product Plan to order
    planOptions ZonePlanOption[]
    Product Plan to order
    dnssec_supported bool
    Is DNSSEC supported by this zone
    has_dns_anycast bool
    hasDnsAnycast flag of the DNS zone
    last_update str
    Last update date of the DNS zone
    name str
    Zone name
    name_servers Sequence[str]
    Name servers that host the DNS zone
    orders Sequence[domain.ZoneOrderArgs]
    Details about an Order
    ovh_subsidiary str
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    payment_mean str
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    plan domain.ZonePlanArgs
    Product Plan to order
    plan_options Sequence[domain.ZonePlanOptionArgs]
    Product Plan to order
    zone_urn str
    ZoneURN String
    dnssecSupported Boolean
    Is DNSSEC supported by this zone
    hasDnsAnycast Boolean
    hasDnsAnycast flag of the DNS zone
    lastUpdate String
    Last update date of the DNS zone
    name String
    Zone name
    nameServers List<String>
    Name servers that host the DNS zone
    orders List<Property Map>
    Details about an Order
    ovhSubsidiary String
    OVHcloud Subsidiary. Country of OVHcloud legal entity you'll be billed by. List of supported subsidiaries available on API at /1.0/me.json under models.nichandle.OvhSubsidiaryEnum
    paymentMean String
    Ovh payment mode

    Deprecated: This field is not anymore used since the API has been deprecated in favor of /payment/mean. Now, the default payment mean is used.

    plan Property Map
    Product Plan to order
    planOptions List<Property Map>
    Product Plan to order

    Supporting Types

    ZoneOrder, ZoneOrderArgs

    Date string
    date
    Details List<ZoneOrderDetail>
    Information about a Bill entry
    ExpirationDate string
    expiration date
    OrderId int
    order id
    Date string
    date
    Details []ZoneOrderDetail
    Information about a Bill entry
    ExpirationDate string
    expiration date
    OrderId int
    order id
    date String
    date
    details List<ZoneOrderDetail>
    Information about a Bill entry
    expirationDate String
    expiration date
    orderId Integer
    order id
    date string
    date
    details ZoneOrderDetail[]
    Information about a Bill entry
    expirationDate string
    expiration date
    orderId number
    order id
    date str
    date
    details Sequence[domain.ZoneOrderDetail]
    Information about a Bill entry
    expiration_date str
    expiration date
    order_id int
    order id
    date String
    date
    details List<Property Map>
    Information about a Bill entry
    expirationDate String
    expiration date
    orderId Number
    order id

    ZoneOrderDetail, ZoneOrderDetailArgs

    Description string
    description
    Domain string
    expiration date
    OrderDetailId int
    order detail id
    Quantity string
    quantity
    Description string
    description
    Domain string
    expiration date
    OrderDetailId int
    order detail id
    Quantity string
    quantity
    description String
    description
    domain String
    expiration date
    orderDetailId Integer
    order detail id
    quantity String
    quantity
    description string
    description
    domain string
    expiration date
    orderDetailId number
    order detail id
    quantity string
    quantity
    description str
    description
    domain str
    expiration date
    order_detail_id int
    order detail id
    quantity str
    quantity
    description String
    description
    domain String
    expiration date
    orderDetailId Number
    order detail id
    quantity String
    quantity

    ZonePlan, ZonePlanArgs

    Duration string
    duration
    PlanCode string
    Plan code
    PricingMode string
    Pricing model identifier
    CatalogName string
    Catalog name
    Configurations List<ZonePlanConfiguration>
    Representation of a configuration item for personalizing product. 2 configurations are required : one for zone and one for template
    Duration string
    duration
    PlanCode string
    Plan code
    PricingMode string
    Pricing model identifier
    CatalogName string
    Catalog name
    Configurations []ZonePlanConfiguration
    Representation of a configuration item for personalizing product. 2 configurations are required : one for zone and one for template
    duration String
    duration
    planCode String
    Plan code
    pricingMode String
    Pricing model identifier
    catalogName String
    Catalog name
    configurations List<ZonePlanConfiguration>
    Representation of a configuration item for personalizing product. 2 configurations are required : one for zone and one for template
    duration string
    duration
    planCode string
    Plan code
    pricingMode string
    Pricing model identifier
    catalogName string
    Catalog name
    configurations ZonePlanConfiguration[]
    Representation of a configuration item for personalizing product. 2 configurations are required : one for zone and one for template
    duration str
    duration
    plan_code str
    Plan code
    pricing_mode str
    Pricing model identifier
    catalog_name str
    Catalog name
    configurations Sequence[domain.ZonePlanConfiguration]
    Representation of a configuration item for personalizing product. 2 configurations are required : one for zone and one for template
    duration String
    duration
    planCode String
    Plan code
    pricingMode String
    Pricing model identifier
    catalogName String
    Catalog name
    configurations List<Property Map>
    Representation of a configuration item for personalizing product. 2 configurations are required : one for zone and one for template

    ZonePlanConfiguration, ZonePlanConfigurationArgs

    Label string
    Identifier of the resource : zone or template
    Value string
    For zone, the value is the zone name myzone.example.com. For template, the value can be basic, minimized or redirect which is the same as minimized with additional entries for a redirect configuration.
    Label string
    Identifier of the resource : zone or template
    Value string
    For zone, the value is the zone name myzone.example.com. For template, the value can be basic, minimized or redirect which is the same as minimized with additional entries for a redirect configuration.
    label String
    Identifier of the resource : zone or template
    value String
    For zone, the value is the zone name myzone.example.com. For template, the value can be basic, minimized or redirect which is the same as minimized with additional entries for a redirect configuration.
    label string
    Identifier of the resource : zone or template
    value string
    For zone, the value is the zone name myzone.example.com. For template, the value can be basic, minimized or redirect which is the same as minimized with additional entries for a redirect configuration.
    label str
    Identifier of the resource : zone or template
    value str
    For zone, the value is the zone name myzone.example.com. For template, the value can be basic, minimized or redirect which is the same as minimized with additional entries for a redirect configuration.
    label String
    Identifier of the resource : zone or template
    value String
    For zone, the value is the zone name myzone.example.com. For template, the value can be basic, minimized or redirect which is the same as minimized with additional entries for a redirect configuration.

    ZonePlanOption, ZonePlanOptionArgs

    Duration string
    duration
    PlanCode string
    Plan code
    PricingMode string
    Pricing model identifier
    CatalogName string
    Catalog name
    Configurations List<ZonePlanOptionConfiguration>
    Representation of a configuration item for personalizing product
    Duration string
    duration
    PlanCode string
    Plan code
    PricingMode string
    Pricing model identifier
    CatalogName string
    Catalog name
    Configurations []ZonePlanOptionConfiguration
    Representation of a configuration item for personalizing product
    duration String
    duration
    planCode String
    Plan code
    pricingMode String
    Pricing model identifier
    catalogName String
    Catalog name
    configurations List<ZonePlanOptionConfiguration>
    Representation of a configuration item for personalizing product
    duration string
    duration
    planCode string
    Plan code
    pricingMode string
    Pricing model identifier
    catalogName string
    Catalog name
    configurations ZonePlanOptionConfiguration[]
    Representation of a configuration item for personalizing product
    duration str
    duration
    plan_code str
    Plan code
    pricing_mode str
    Pricing model identifier
    catalog_name str
    Catalog name
    configurations Sequence[domain.ZonePlanOptionConfiguration]
    Representation of a configuration item for personalizing product
    duration String
    duration
    planCode String
    Plan code
    pricingMode String
    Pricing model identifier
    catalogName String
    Catalog name
    configurations List<Property Map>
    Representation of a configuration item for personalizing product

    ZonePlanOptionConfiguration, ZonePlanOptionConfigurationArgs

    Label string
    Identifier of the resource
    Value string
    Path to the resource in API.OVH.COM
    Label string
    Identifier of the resource
    Value string
    Path to the resource in API.OVH.COM
    label String
    Identifier of the resource
    value String
    Path to the resource in API.OVH.COM
    label string
    Identifier of the resource
    value string
    Path to the resource in API.OVH.COM
    label str
    Identifier of the resource
    value str
    Path to the resource in API.OVH.COM
    label String
    Identifier of the resource
    value String
    Path to the resource in API.OVH.COM

    Import

    Zone can be imported using its name.

    Using the following configuration:

    hcl

    import {

    to = ovh_domain_zone.zone

    id = “

    }

    You can then run:

    bash

    $ pulumi preview -generate-config-out=zone.tf

    $ pulumi up

    The file zone.tf will then contain the imported resource’s configuration, that can be copied next to the import block above.

    See https://developer.hashicorp.com/terraform/language/import/generating-configuration for more details.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v1.1.0 published on Thursday, Nov 21, 2024 by OVHcloud