1. Packages
  2. Azure Native
  3. API Docs
  4. iotcentral
  5. App
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.65.0 published on Monday, Oct 7, 2024 by Pulumi

azure-native.iotcentral.App

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.65.0 published on Monday, Oct 7, 2024 by Pulumi

    The IoT Central application. Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-06-01.

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

    Example Usage

    Apps_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var app = new AzureNative.IoTCentral.App("app", new()
        {
            DisplayName = "My IoT Central App",
            Identity = new AzureNative.IoTCentral.Inputs.SystemAssignedServiceIdentityArgs
            {
                Type = AzureNative.IoTCentral.SystemAssignedServiceIdentityType.SystemAssigned,
            },
            Location = "westus",
            ResourceGroupName = "resRg",
            ResourceName = "myIoTCentralApp",
            Sku = new AzureNative.IoTCentral.Inputs.AppSkuInfoArgs
            {
                Name = AzureNative.IoTCentral.AppSku.ST2,
            },
            Subdomain = "my-iot-central-app",
            Template = "iotc-pnp-preview@1.0.0",
        });
    
    });
    
    package main
    
    import (
    	iotcentral "github.com/pulumi/pulumi-azure-native-sdk/iotcentral/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iotcentral.NewApp(ctx, "app", &iotcentral.AppArgs{
    			DisplayName: pulumi.String("My IoT Central App"),
    			Identity: &iotcentral.SystemAssignedServiceIdentityArgs{
    				Type: pulumi.String(iotcentral.SystemAssignedServiceIdentityTypeSystemAssigned),
    			},
    			Location:          pulumi.String("westus"),
    			ResourceGroupName: pulumi.String("resRg"),
    			ResourceName:      pulumi.String("myIoTCentralApp"),
    			Sku: &iotcentral.AppSkuInfoArgs{
    				Name: pulumi.String(iotcentral.AppSkuST2),
    			},
    			Subdomain: pulumi.String("my-iot-central-app"),
    			Template:  pulumi.String("iotc-pnp-preview@1.0.0"),
    		})
    		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.iotcentral.App;
    import com.pulumi.azurenative.iotcentral.AppArgs;
    import com.pulumi.azurenative.iotcentral.inputs.SystemAssignedServiceIdentityArgs;
    import com.pulumi.azurenative.iotcentral.inputs.AppSkuInfoArgs;
    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 app = new App("app", AppArgs.builder()
                .displayName("My IoT Central App")
                .identity(SystemAssignedServiceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .location("westus")
                .resourceGroupName("resRg")
                .resourceName("myIoTCentralApp")
                .sku(AppSkuInfoArgs.builder()
                    .name("ST2")
                    .build())
                .subdomain("my-iot-central-app")
                .template("iotc-pnp-preview@1.0.0")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    app = azure_native.iotcentral.App("app",
        display_name="My IoT Central App",
        identity={
            "type": azure_native.iotcentral.SystemAssignedServiceIdentityType.SYSTEM_ASSIGNED,
        },
        location="westus",
        resource_group_name="resRg",
        resource_name_="myIoTCentralApp",
        sku={
            "name": azure_native.iotcentral.AppSku.ST2,
        },
        subdomain="my-iot-central-app",
        template="iotc-pnp-preview@1.0.0")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const app = new azure_native.iotcentral.App("app", {
        displayName: "My IoT Central App",
        identity: {
            type: azure_native.iotcentral.SystemAssignedServiceIdentityType.SystemAssigned,
        },
        location: "westus",
        resourceGroupName: "resRg",
        resourceName: "myIoTCentralApp",
        sku: {
            name: azure_native.iotcentral.AppSku.ST2,
        },
        subdomain: "my-iot-central-app",
        template: "iotc-pnp-preview@1.0.0",
    });
    
    resources:
      app:
        type: azure-native:iotcentral:App
        properties:
          displayName: My IoT Central App
          identity:
            type: SystemAssigned
          location: westus
          resourceGroupName: resRg
          resourceName: myIoTCentralApp
          sku:
            name: ST2
          subdomain: my-iot-central-app
          template: iotc-pnp-preview@1.0.0
    

    Create App Resource

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

    Constructor syntax

    new App(name: string, args: AppArgs, opts?: CustomResourceOptions);
    @overload
    def App(resource_name: str,
            args: AppArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def App(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            sku: Optional[AppSkuInfoArgs] = None,
            display_name: Optional[str] = None,
            identity: Optional[SystemAssignedServiceIdentityArgs] = None,
            location: Optional[str] = None,
            resource_name_: Optional[str] = None,
            subdomain: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            template: Optional[str] = None)
    func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
    public App(string name, AppArgs args, CustomResourceOptions? opts = null)
    public App(String name, AppArgs args)
    public App(String name, AppArgs args, CustomResourceOptions options)
    
    type: azure-native:iotcentral:App
    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 AppArgs
    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 AppArgs
    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 AppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppArgs
    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 azure_nativeAppResource = new AzureNative.IoTCentral.App("azure-nativeAppResource", new()
    {
        ResourceGroupName = "string",
        Sku = new AzureNative.IoTCentral.Inputs.AppSkuInfoArgs
        {
            Name = "string",
        },
        DisplayName = "string",
        Identity = new AzureNative.IoTCentral.Inputs.SystemAssignedServiceIdentityArgs
        {
            Type = "string",
        },
        Location = "string",
        ResourceName = "string",
        Subdomain = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Template = "string",
    });
    
    example, err := iotcentral.NewApp(ctx, "azure-nativeAppResource", &iotcentral.AppArgs{
    	ResourceGroupName: pulumi.String("string"),
    	Sku: &iotcentral.AppSkuInfoArgs{
    		Name: pulumi.String("string"),
    	},
    	DisplayName: pulumi.String("string"),
    	Identity: &iotcentral.SystemAssignedServiceIdentityArgs{
    		Type: pulumi.String("string"),
    	},
    	Location:     pulumi.String("string"),
    	ResourceName: pulumi.String("string"),
    	Subdomain:    pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Template: pulumi.String("string"),
    })
    
    var azure_nativeAppResource = new App("azure-nativeAppResource", AppArgs.builder()
        .resourceGroupName("string")
        .sku(AppSkuInfoArgs.builder()
            .name("string")
            .build())
        .displayName("string")
        .identity(SystemAssignedServiceIdentityArgs.builder()
            .type("string")
            .build())
        .location("string")
        .resourceName("string")
        .subdomain("string")
        .tags(Map.of("string", "string"))
        .template("string")
        .build());
    
    azure_native_app_resource = azure_native.iotcentral.App("azure-nativeAppResource",
        resource_group_name="string",
        sku={
            "name": "string",
        },
        display_name="string",
        identity={
            "type": "string",
        },
        location="string",
        resource_name_="string",
        subdomain="string",
        tags={
            "string": "string",
        },
        template="string")
    
    const azure_nativeAppResource = new azure_native.iotcentral.App("azure-nativeAppResource", {
        resourceGroupName: "string",
        sku: {
            name: "string",
        },
        displayName: "string",
        identity: {
            type: "string",
        },
        location: "string",
        resourceName: "string",
        subdomain: "string",
        tags: {
            string: "string",
        },
        template: "string",
    });
    
    type: azure-native:iotcentral:App
    properties:
        displayName: string
        identity:
            type: string
        location: string
        resourceGroupName: string
        resourceName: string
        sku:
            name: string
        subdomain: string
        tags:
            string: string
        template: string
    

    App 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 App resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group that contains the IoT Central application.
    Sku Pulumi.AzureNative.IoTCentral.Inputs.AppSkuInfo
    A valid instance SKU.
    DisplayName string
    The display name of the application.
    Identity Pulumi.AzureNative.IoTCentral.Inputs.SystemAssignedServiceIdentity
    The managed identities for the IoT Central application.
    Location string
    The resource location.
    ResourceName string
    The ARM resource name of 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.
    ResourceGroupName string
    The name of the resource group that contains the IoT Central application.
    Sku AppSkuInfoArgs
    A valid instance SKU.
    DisplayName string
    The display name of the application.
    Identity SystemAssignedServiceIdentityArgs
    The managed identities for the IoT Central application.
    Location string
    The resource location.
    ResourceName string
    The ARM resource name of 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.
    resourceGroupName String
    The name of the resource group that contains the IoT Central application.
    sku AppSkuInfo
    A valid instance SKU.
    displayName String
    The display name of the application.
    identity SystemAssignedServiceIdentity
    The managed identities for the IoT Central application.
    location String
    The resource location.
    resourceName String
    The ARM resource name of 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.
    resourceGroupName string
    The name of the resource group that contains the IoT Central application.
    sku AppSkuInfo
    A valid instance SKU.
    displayName string
    The display name of the application.
    identity SystemAssignedServiceIdentity
    The managed identities for the IoT Central application.
    location string
    The resource location.
    resourceName string
    The ARM resource name of 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.
    resource_group_name str
    The name of the resource group that contains the IoT Central application.
    sku AppSkuInfoArgs
    A valid instance SKU.
    display_name str
    The display name of the application.
    identity SystemAssignedServiceIdentityArgs
    The managed identities for the IoT Central application.
    location str
    The resource location.
    resource_name str
    The ARM resource name of 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.
    resourceGroupName String
    The name of the resource group that contains the IoT Central application.
    sku Property Map
    A valid instance SKU.
    displayName String
    The display name of the application.
    identity Property Map
    The managed identities for the IoT Central application.
    location String
    The resource location.
    resourceName String
    The ARM resource name of 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.

    Outputs

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

    ApplicationId string
    The ID of the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The ARM resource name.
    State string
    The current state of the application.
    Type string
    The resource type.
    ApplicationId string
    The ID of the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The ARM resource name.
    State string
    The current state of the application.
    Type string
    The resource type.
    applicationId String
    The ID of the application.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The ARM resource name.
    state String
    The current state of the application.
    type String
    The resource type.
    applicationId string
    The ID of the application.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The ARM resource name.
    state string
    The current state of the application.
    type string
    The resource type.
    application_id str
    The ID of the application.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The ARM resource name.
    state str
    The current state of the application.
    type str
    The resource type.
    applicationId String
    The ID of the application.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The ARM resource name.
    state String
    The current state of the application.
    type String
    The resource type.

    Supporting Types

    AppSku, AppSkuArgs

    ST0
    ST0
    ST1
    ST1
    ST2
    ST2
    AppSkuST0
    ST0
    AppSkuST1
    ST1
    AppSkuST2
    ST2
    ST0
    ST0
    ST1
    ST1
    ST2
    ST2
    ST0
    ST0
    ST1
    ST1
    ST2
    ST2
    ST0
    ST0
    ST1
    ST1
    ST2
    ST2
    "ST0"
    ST0
    "ST1"
    ST1
    "ST2"
    ST2

    AppSkuInfo, AppSkuInfoArgs

    Name string | Pulumi.AzureNative.IoTCentral.AppSku
    The name of the SKU.
    Name string | AppSku
    The name of the SKU.
    name String | AppSku
    The name of the SKU.
    name string | AppSku
    The name of the SKU.
    name str | AppSku
    The name of the SKU.
    name String | "ST0" | "ST1" | "ST2"
    The name of the SKU.

    AppSkuInfoResponse, AppSkuInfoResponseArgs

    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.

    SystemAssignedServiceIdentity, SystemAssignedServiceIdentityArgs

    Type string | Pulumi.AzureNative.IoTCentral.SystemAssignedServiceIdentityType
    Type of managed service identity (either system assigned, or none).
    Type string | SystemAssignedServiceIdentityType
    Type of managed service identity (either system assigned, or none).
    type String | SystemAssignedServiceIdentityType
    Type of managed service identity (either system assigned, or none).
    type string | SystemAssignedServiceIdentityType
    Type of managed service identity (either system assigned, or none).
    type str | SystemAssignedServiceIdentityType
    Type of managed service identity (either system assigned, or none).
    type String | "None" | "SystemAssigned"
    Type of managed service identity (either system assigned, or none).

    SystemAssignedServiceIdentityResponse, SystemAssignedServiceIdentityResponseArgs

    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).

    SystemAssignedServiceIdentityType, SystemAssignedServiceIdentityTypeArgs

    None
    None
    SystemAssigned
    SystemAssigned
    SystemAssignedServiceIdentityTypeNone
    None
    SystemAssignedServiceIdentityTypeSystemAssigned
    SystemAssigned
    None
    None
    SystemAssigned
    SystemAssigned
    None
    None
    SystemAssigned
    SystemAssigned
    NONE
    None
    SYSTEM_ASSIGNED
    SystemAssigned
    "None"
    None
    "SystemAssigned"
    SystemAssigned

    Import

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

    $ pulumi import azure-native:iotcentral:App myIoTCentralApp /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName} 
    

    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.65.0 published on Monday, Oct 7, 2024 by Pulumi