<filename>sdk/dotnet/GetMetalVRF.cs// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Threading.Tasks;
using Pulumi.Serialization;
using Pulumi;

namespace Cuemby.Equinix
{
    public static class GetMetalVRF
    {
        /// <summary>
        /// Use this data source to retrieve a VRF resource.
        /// 
        /// &gt; VRF features are not generally available. The interfaces related to VRF resources may change ahead of general availability.
        /// 
        /// {{% examples %}}
        /// ## Example Usage
        /// {{% example %}}
        /// 
        /// ```csharp
        /// using Pulumi;
        /// using Equinix = Pulumi.Equinix;
        /// 
        /// class MyStack : Stack
        /// {
        ///     public MyStack()
        ///     {
        ///         var exampleVrf = Output.Create(Equinix.GetMetalVRF.InvokeAsync(new Equinix.GetMetalVRFArgs
        ///         {
        ///             VrfId = "48630899-9ff2-4ce6-a93f-50ff4ebcdf6e",
        ///         }));
        ///     }
        /// 
        /// }
        /// ```
        /// {{% /example %}}
        /// {{% /examples %}}
        /// </summary>
        public static Task<GetMetalVRFResult> InvokeAsync(GetMetalVRFArgs args, InvokeOptions? options = null)
            => Pulumi.Deployment.Instance.InvokeAsync<GetMetalVRFResult>("equinix:index/getMetalVRF:GetMetalVRF", args ?? new GetMetalVRFArgs(), options.WithDefaults());

        /// <summary>
        /// Use this data source to retrieve a VRF resource.
        /// 
        /// &gt; VRF features are not generally available. The interfaces related to VRF resources may change ahead of general availability.
        /// 
        /// {{% examples %}}
        /// ## Example Usage
        /// {{% example %}}
        /// 
        /// ```csharp
        /// using Pulumi;
        /// using Equinix = Pulumi.Equinix;
        /// 
        /// class MyStack : Stack
        /// {
        ///     public MyStack()
        ///     {
        ///         var exampleVrf = Output.Create(Equinix.GetMetalVRF.InvokeAsync(new Equinix.GetMetalVRFArgs
        ///         {
        ///             VrfId = "48630899-9ff2-4ce6-a93f-50ff4ebcdf6e",
        ///         }));
        ///     }
        /// 
        /// }
        /// ```
        /// {{% /example %}}
        /// {{% /examples %}}
        /// </summary>
        public static Output<GetMetalVRFResult> Invoke(GetMetalVRFInvokeArgs args, InvokeOptions? options = null)
            => Pulumi.Deployment.Instance.Invoke<GetMetalVRFResult>("equinix:index/getMetalVRF:GetMetalVRF", args ?? new GetMetalVRFInvokeArgs(), options.WithDefaults());
    }


    public sealed class GetMetalVRFArgs : Pulumi.InvokeArgs
    {
        /// <summary>
        /// ID of the VRF resource
        /// </summary>
        [Input("vrfId", required: true)]
        public string VrfId { get; set; } = null!;

        public GetMetalVRFArgs()
        {
        }
    }

    public sealed class GetMetalVRFInvokeArgs : Pulumi.InvokeArgs
    {
        /// <summary>
        /// ID of the VRF resource
        /// </summary>
        [Input("vrfId", required: true)]
        public Input<string> VrfId { get; set; } = null!;

        public GetMetalVRFInvokeArgs()
        {
        }
    }


    [OutputType]
    public sealed class GetMetalVRFResult
    {
        /// <summary>
        /// Description of the VRF.
        /// </summary>
        public readonly string Description;
        /// <summary>
        /// The provider-assigned unique ID for this managed resource.
        /// </summary>
        public readonly string Id;
        /// <summary>
        /// All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF.
        /// </summary>
        public readonly ImmutableArray<string> IpRanges;
        /// <summary>
        /// The 4-byte ASN set on the VRF.
        /// </summary>
        public readonly int LocalAsn;
        /// <summary>
        /// Metro ID or Code where the VRF will be deployed.
        /// </summary>
        public readonly string Metro;
        /// <summary>
        /// User-supplied name of the VRF, unique to the project
        /// </summary>
        public readonly string Name;
        /// <summary>
        /// Project ID where the VRF will be deployed.
        /// </summary>
        public readonly string ProjectId;
        public readonly string VrfId;

        [OutputConstructor]
        private GetMetalVRFResult(
            string description,

            string id,

            ImmutableArray<string> ipRanges,

            int localAsn,

            string metro,

            string name,

            string projectId,

            string vrfId)
        {
            Description = description;
            Id = id;
            IpRanges = ipRanges;
            LocalAsn = localAsn;
            Metro = metro;
            Name = name;
            ProjectId = projectId;
            VrfId = vrfId;
        }
    }
}
