1. Packages
  2. Azure Native
  3. API Docs
  4. iotcentral
  5. getApp
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.iotcentral.getApp

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Get the metadata of an IoT Central application. Azure REST API version: 2021-06-01.

    Other available API versions: 2018-09-01, 2021-11-01-preview.

    Using getApp

    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 getApp(args: GetAppArgs, opts?: InvokeOptions): Promise<GetAppResult>
    function getAppOutput(args: GetAppOutputArgs, opts?: InvokeOptions): Output<GetAppResult>
    def get_app(resource_group_name: Optional[str] = None,
                resource_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetAppResult
    def get_app_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                resource_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetAppResult]
    func LookupApp(ctx *Context, args *LookupAppArgs, opts ...InvokeOption) (*LookupAppResult, error)
    func LookupAppOutput(ctx *Context, args *LookupAppOutputArgs, opts ...InvokeOption) LookupAppResultOutput

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

    public static class GetApp 
    {
        public static Task<GetAppResult> InvokeAsync(GetAppArgs args, InvokeOptions? opts = null)
        public static Output<GetAppResult> Invoke(GetAppInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:iotcentral:getApp
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group that contains the IoT Central application.
    ResourceName string
    The ARM resource name of the IoT Central application.
    ResourceGroupName string
    The name of the resource group that contains the IoT Central application.
    ResourceName string
    The ARM resource name of the IoT Central application.
    resourceGroupName String
    The name of the resource group that contains the IoT Central application.
    resourceName String
    The ARM resource name of the IoT Central application.
    resourceGroupName string
    The name of the resource group that contains the IoT Central application.
    resourceName string
    The ARM resource name of the IoT Central application.
    resource_group_name str
    The name of the resource group that contains the IoT Central application.
    resource_name str
    The ARM resource name of the IoT Central application.
    resourceGroupName String
    The name of the resource group that contains the IoT Central application.
    resourceName String
    The ARM resource name of the IoT Central application.

    getApp Result

    The following output properties are available:

    ApplicationId string
    The ID of the application.
    Id string
    The ARM resource identifier.
    Location string
    The resource location.
    Name string
    The ARM resource name.
    Sku Pulumi.AzureNative.IoTCentral.Outputs.AppSkuInfoResponse
    A valid instance SKU.
    State string
    The current state of the application.
    Type string
    The resource type.
    DisplayName string
    The display name of the application.
    Identity Pulumi.AzureNative.IoTCentral.Outputs.SystemAssignedServiceIdentityResponse
    The managed identities for the IoT Central application.
    Subdomain string
    The subdomain of the application.
    Tags Dictionary<string, string>
    The resource tags.
    Template string
    The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
    ApplicationId string
    The ID of the application.
    Id string
    The ARM resource identifier.
    Location string
    The resource location.
    Name string
    The ARM resource name.
    Sku AppSkuInfoResponse
    A valid instance SKU.
    State string
    The current state of the application.
    Type string
    The resource type.
    DisplayName string
    The display name of the application.
    Identity SystemAssignedServiceIdentityResponse
    The managed identities for the IoT Central application.
    Subdomain string
    The subdomain of the application.
    Tags map[string]string
    The resource tags.
    Template string
    The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
    applicationId String
    The ID of the application.
    id String
    The ARM resource identifier.
    location String
    The resource location.
    name String
    The ARM resource name.
    sku AppSkuInfoResponse
    A valid instance SKU.
    state String
    The current state of the application.
    type String
    The resource type.
    displayName String
    The display name of the application.
    identity SystemAssignedServiceIdentityResponse
    The managed identities for the IoT Central application.
    subdomain String
    The subdomain of the application.
    tags Map<String,String>
    The resource tags.
    template String
    The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
    applicationId string
    The ID of the application.
    id string
    The ARM resource identifier.
    location string
    The resource location.
    name string
    The ARM resource name.
    sku AppSkuInfoResponse
    A valid instance SKU.
    state string
    The current state of the application.
    type string
    The resource type.
    displayName string
    The display name of the application.
    identity SystemAssignedServiceIdentityResponse
    The managed identities for the IoT Central application.
    subdomain string
    The subdomain of the application.
    tags {[key: string]: string}
    The resource tags.
    template string
    The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
    application_id str
    The ID of the application.
    id str
    The ARM resource identifier.
    location str
    The resource location.
    name str
    The ARM resource name.
    sku AppSkuInfoResponse
    A valid instance SKU.
    state str
    The current state of the application.
    type str
    The resource type.
    display_name str
    The display name of the application.
    identity SystemAssignedServiceIdentityResponse
    The managed identities for the IoT Central application.
    subdomain str
    The subdomain of the application.
    tags Mapping[str, str]
    The resource tags.
    template str
    The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
    applicationId String
    The ID of the application.
    id String
    The ARM resource identifier.
    location String
    The resource location.
    name String
    The ARM resource name.
    sku Property Map
    A valid instance SKU.
    state String
    The current state of the application.
    type String
    The resource type.
    displayName String
    The display name of the application.
    identity Property Map
    The managed identities for the IoT Central application.
    subdomain String
    The subdomain of the application.
    tags Map<String>
    The resource tags.
    template String
    The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.

    Supporting Types

    AppSkuInfoResponse

    Name string
    The name of the SKU.
    Name string
    The name of the SKU.
    name String
    The name of the SKU.
    name string
    The name of the SKU.
    name str
    The name of the SKU.
    name String
    The name of the SKU.

    SystemAssignedServiceIdentityResponse

    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (either system assigned, or none).
    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (either system assigned, or none).
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (either system assigned, or none).
    principalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type string
    Type of managed service identity (either system assigned, or none).
    principal_id str
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type str
    Type of managed service identity (either system assigned, or none).
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (either system assigned, or none).

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi