Set-AzIotCentralApp

Module:

Az.IotCentral Module

Updates the metadata for an IoT Central Application.

Syntax

ResourceIdParameterSet (Default)

Set-AzIotCentralApp
    -ResourceId <String>
    [-DisplayName <String>]
    [-Subdomain <String>]
    [-Tag <Hashtable>]
    [-Sku <String>]
    [-Identity <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectParameterSet

Set-AzIotCentralApp
    -InputObject <PSIotCentralApp>
    [-DisplayName <String>]
    [-Subdomain <String>]
    [-Tag <Hashtable>]
    [-Sku <String>]
    [-Identity <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InteractiveIotCentralParameterSet

Set-AzIotCentralApp
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-DisplayName <String>]
    [-Subdomain <String>]
    [-Tag <Hashtable>]
    [-Sku <String>]
    [-Identity <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the metadata for an IoT Central Application.

Examples

Example 1 Update Display Name

Set-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -DisplayName "My New Custom Display Name"

ResourceId        : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft
                    .IoTCentral/IoTApps/MyAppResourceName
Name              : MyAppResourceName
Type              : Microsoft.IoTCentral/IoTApps
Location          : westus
Tag               :
Sku               : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo
ApplicationId     : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
DisplayName       : My New Custom Display Name
Subdomain         : MyAppSubdomain
Template          : iotc-default@1.0.0
SubscriptionId    : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ResourceGroupName : MyResourceGroupName
Identity          : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity

Update the Display name on an existing IoT Central Application.

Example 2 Update Subdomain

Set-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -Subdomain "new-subdomain"

ResourceId        : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft
                    .IoTCentral/IoTApps/MyAppResourceName
Name              : MyAppResourceName
Type              : Microsoft.IoTCentral/IoTApps
Location          : westus
Tag               :
Sku               : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo
ApplicationId     : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
DisplayName       : Display Name
Subdomain         : new-subdomain
Template          : iotc-default@1.0.0
SubscriptionId    : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ResourceGroupName : MyResourceGroupName
Identity          : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity

Update the Display name on an existing IoT Central Application.

Example 3 Update App Sku Info

Set-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName" -Sku "ST2"

ResourceId        : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft
                    .IoTCentral/IoTApps/MyAppResourceName
Name              : MyAppResourceName
Type              : Microsoft.IoTCentral/IoTApps
Location          : westus
Tag               :
Sku               : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo
ApplicationId     : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
DisplayName       : Display Name
Subdomain         : MyAppSubdomain
Template          : iotc-default@1.0.0
SubscriptionId    : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ResourceGroupName : MyResourceGroupName
Identity          : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity

Update the sku on an existing IoT Central Application.

Parameters

-AsJob

Run cmdlet as a job in the background.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DisplayName

Custom Display Name of the Iot Central Application.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Identity

The type of managed identity for the IoT Central application. Default value is None. System-assigned managed identities are supported.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Iot Central Application Input Object.

Parameter properties

Type:	PSIotCentralApp
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

InputObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Name of the Iot Central Application Resource.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

InteractiveIotCentralParameterSet

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Name of the Resource Group.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

InteractiveIotCentralParameterSet

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

Iot Central Application Resource Id.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ResourceIdParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Sku

Pricing tier for IoT Central applications. Default value is ST2.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Subdomain

Subdomain of the IoT Central Application.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Tag

Iot Central Application Resource Tags.

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

PSIotCentralApp

Outputs

PSIotCentralApp