1. Packages
  2. Azure Native
  3. API Docs
  4. orbital
  5. EdgeSite
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi

azure-native.orbital.EdgeSite

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi

    A customer’s reference to a global communications site site. Azure REST API version: 2024-03-01-preview.

    Other available API versions: 2024-03-01.

    Example Usage

    Create Edge Site

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var edgeSite = new AzureNative.Orbital.EdgeSite("edgeSite", new()
        {
            EdgeSiteName = "es1",
            GlobalCommunicationsSite = new AzureNative.Orbital.Inputs.EdgeSitesPropertiesGlobalCommunicationsSiteArgs
            {
                Id = "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon",
            },
            Location = "westus",
            ResourceGroupName = "rg1",
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value2" },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/orbital/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := orbital.NewEdgeSite(ctx, "edgeSite", &orbital.EdgeSiteArgs{
    			EdgeSiteName: pulumi.String("es1"),
    			GlobalCommunicationsSite: &orbital.EdgeSitesPropertiesGlobalCommunicationsSiteArgs{
    				Id: pulumi.String("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon"),
    			},
    			Location:          pulumi.String("westus"),
    			ResourceGroupName: pulumi.String("rg1"),
    			Tags: pulumi.StringMap{
    				"tag1": pulumi.String("value1"),
    				"tag2": pulumi.String("value2"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.orbital.EdgeSite;
    import com.pulumi.azurenative.orbital.EdgeSiteArgs;
    import com.pulumi.azurenative.orbital.inputs.EdgeSitesPropertiesGlobalCommunicationsSiteArgs;
    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) {
            var edgeSite = new EdgeSite("edgeSite", EdgeSiteArgs.builder()        
                .edgeSiteName("es1")
                .globalCommunicationsSite(EdgeSitesPropertiesGlobalCommunicationsSiteArgs.builder()
                    .id("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon")
                    .build())
                .location("westus")
                .resourceGroupName("rg1")
                .tags(Map.ofEntries(
                    Map.entry("tag1", "value1"),
                    Map.entry("tag2", "value2")
                ))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    edge_site = azure_native.orbital.EdgeSite("edgeSite",
        edge_site_name="es1",
        global_communications_site=azure_native.orbital.EdgeSitesPropertiesGlobalCommunicationsSiteArgs(
            id="/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon",
        ),
        location="westus",
        resource_group_name="rg1",
        tags={
            "tag1": "value1",
            "tag2": "value2",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const edgeSite = new azure_native.orbital.EdgeSite("edgeSite", {
        edgeSiteName: "es1",
        globalCommunicationsSite: {
            id: "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon",
        },
        location: "westus",
        resourceGroupName: "rg1",
        tags: {
            tag1: "value1",
            tag2: "value2",
        },
    });
    
    resources:
      edgeSite:
        type: azure-native:orbital:EdgeSite
        properties:
          edgeSiteName: es1
          globalCommunicationsSite:
            id: /subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon
          location: westus
          resourceGroupName: rg1
          tags:
            tag1: value1
            tag2: value2
    

    Create EdgeSite Resource

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

    Constructor syntax

    new EdgeSite(name: string, args: EdgeSiteArgs, opts?: CustomResourceOptions);
    @overload
    def EdgeSite(resource_name: str,
                 args: EdgeSiteArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def EdgeSite(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 global_communications_site: Optional[EdgeSitesPropertiesGlobalCommunicationsSiteArgs] = None,
                 resource_group_name: Optional[str] = None,
                 edge_site_name: Optional[str] = None,
                 location: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None)
    func NewEdgeSite(ctx *Context, name string, args EdgeSiteArgs, opts ...ResourceOption) (*EdgeSite, error)
    public EdgeSite(string name, EdgeSiteArgs args, CustomResourceOptions? opts = null)
    public EdgeSite(String name, EdgeSiteArgs args)
    public EdgeSite(String name, EdgeSiteArgs args, CustomResourceOptions options)
    
    type: azure-native:orbital:EdgeSite
    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 EdgeSiteArgs
    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 EdgeSiteArgs
    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 EdgeSiteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeSiteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeSiteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var edgeSiteResource = new AzureNative.Orbital.EdgeSite("edgeSiteResource", new()
    {
        GlobalCommunicationsSite = new AzureNative.Orbital.Inputs.EdgeSitesPropertiesGlobalCommunicationsSiteArgs
        {
            Id = "string",
        },
        ResourceGroupName = "string",
        EdgeSiteName = "string",
        Location = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := orbital.NewEdgeSite(ctx, "edgeSiteResource", &orbital.EdgeSiteArgs{
    GlobalCommunicationsSite: &orbital.EdgeSitesPropertiesGlobalCommunicationsSiteArgs{
    Id: pulumi.String("string"),
    },
    ResourceGroupName: pulumi.String("string"),
    EdgeSiteName: pulumi.String("string"),
    Location: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var edgeSiteResource = new EdgeSite("edgeSiteResource", EdgeSiteArgs.builder()        
        .globalCommunicationsSite(EdgeSitesPropertiesGlobalCommunicationsSiteArgs.builder()
            .id("string")
            .build())
        .resourceGroupName("string")
        .edgeSiteName("string")
        .location("string")
        .tags(Map.of("string", "string"))
        .build());
    
    edge_site_resource = azure_native.orbital.EdgeSite("edgeSiteResource",
        global_communications_site=azure_native.orbital.EdgeSitesPropertiesGlobalCommunicationsSiteArgs(
            id="string",
        ),
        resource_group_name="string",
        edge_site_name="string",
        location="string",
        tags={
            "string": "string",
        })
    
    const edgeSiteResource = new azure_native.orbital.EdgeSite("edgeSiteResource", {
        globalCommunicationsSite: {
            id: "string",
        },
        resourceGroupName: "string",
        edgeSiteName: "string",
        location: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:orbital:EdgeSite
    properties:
        edgeSiteName: string
        globalCommunicationsSite:
            id: string
        location: string
        resourceGroupName: string
        tags:
            string: string
    

    EdgeSite Resource Properties

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

    Inputs

    The EdgeSite resource accepts the following input properties:

    GlobalCommunicationsSite Pulumi.AzureNative.Orbital.Inputs.EdgeSitesPropertiesGlobalCommunicationsSite
    A reference to global communications site.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    EdgeSiteName string
    Edge site name.
    Location string
    The geo-location where the resource lives
    Tags Dictionary<string, string>
    Resource tags.
    GlobalCommunicationsSite EdgeSitesPropertiesGlobalCommunicationsSiteArgs
    A reference to global communications site.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    EdgeSiteName string
    Edge site name.
    Location string
    The geo-location where the resource lives
    Tags map[string]string
    Resource tags.
    globalCommunicationsSite EdgeSitesPropertiesGlobalCommunicationsSite
    A reference to global communications site.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    edgeSiteName String
    Edge site name.
    location String
    The geo-location where the resource lives
    tags Map<String,String>
    Resource tags.
    globalCommunicationsSite EdgeSitesPropertiesGlobalCommunicationsSite
    A reference to global communications site.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    edgeSiteName string
    Edge site name.
    location string
    The geo-location where the resource lives
    tags {[key: string]: string}
    Resource tags.
    global_communications_site EdgeSitesPropertiesGlobalCommunicationsSiteArgs
    A reference to global communications site.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    edge_site_name str
    Edge site name.
    location str
    The geo-location where the resource lives
    tags Mapping[str, str]
    Resource tags.
    globalCommunicationsSite Property Map
    A reference to global communications site.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    edgeSiteName String
    Edge site name.
    location String
    The geo-location where the resource lives
    tags Map<String>
    Resource tags.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Orbital.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    EdgeSitesPropertiesGlobalCommunicationsSite, EdgeSitesPropertiesGlobalCommunicationsSiteArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    EdgeSitesPropertiesResponseGlobalCommunicationsSite, EdgeSitesPropertiesResponseGlobalCommunicationsSiteArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:orbital:EdgeSite es1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/edgeSites/{edgeSiteName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi