1. Packages
  2. Azure Native
  3. API Docs
  4. orbital
  5. getEdgeSite
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.orbital.getEdgeSite

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Gets the specified edge site in a specified resource group.

    Uses Azure REST API version 2024-03-01-preview.

    Other available API versions: 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native orbital [ApiVersion]. See the version guide for details.

    Using getEdgeSite

    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 getEdgeSite(args: GetEdgeSiteArgs, opts?: InvokeOptions): Promise<GetEdgeSiteResult>
    function getEdgeSiteOutput(args: GetEdgeSiteOutputArgs, opts?: InvokeOptions): Output<GetEdgeSiteResult>
    def get_edge_site(edge_site_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetEdgeSiteResult
    def get_edge_site_output(edge_site_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetEdgeSiteResult]
    func LookupEdgeSite(ctx *Context, args *LookupEdgeSiteArgs, opts ...InvokeOption) (*LookupEdgeSiteResult, error)
    func LookupEdgeSiteOutput(ctx *Context, args *LookupEdgeSiteOutputArgs, opts ...InvokeOption) LookupEdgeSiteResultOutput

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

    public static class GetEdgeSite 
    {
        public static Task<GetEdgeSiteResult> InvokeAsync(GetEdgeSiteArgs args, InvokeOptions? opts = null)
        public static Output<GetEdgeSiteResult> Invoke(GetEdgeSiteInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEdgeSiteResult> getEdgeSite(GetEdgeSiteArgs args, InvokeOptions options)
    public static Output<GetEdgeSiteResult> getEdgeSite(GetEdgeSiteArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:orbital:getEdgeSite
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EdgeSiteName string
    Edge site name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    EdgeSiteName string
    Edge site name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    edgeSiteName String
    Edge site name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    edgeSiteName string
    Edge site name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    edge_site_name str
    Edge site name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    edgeSiteName String
    Edge site name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getEdgeSite Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    GlobalCommunicationsSite Pulumi.AzureNative.Orbital.Outputs.EdgeSitesPropertiesResponseGlobalCommunicationsSite
    A reference to global communications site.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    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"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    GlobalCommunicationsSite EdgeSitesPropertiesResponseGlobalCommunicationsSite
    A reference to global communications site.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    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"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    globalCommunicationsSite EdgeSitesPropertiesResponseGlobalCommunicationsSite
    A reference to global communications site.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    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"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    globalCommunicationsSite EdgeSitesPropertiesResponseGlobalCommunicationsSite
    A reference to global communications site.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    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"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    global_communications_site EdgeSitesPropertiesResponseGlobalCommunicationsSite
    A reference to global communications site.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    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"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    globalCommunicationsSite Property Map
    A reference to global communications site.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    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"
    tags Map<String>
    Resource tags.

    Supporting Types

    EdgeSitesPropertiesResponseGlobalCommunicationsSite

    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

    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.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi