Get-AzIotCentralApp
Gets properties for either one or several IoT Central Applications.
Syntax
Get-AzIotCentralApp
[[-ResourceGroupName] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzIotCentralApp
[-ResourceGroupName] <String>
[-Name] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzIotCentralApp
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Gets the metadata for either a specific IoT Central Application, or all the applications in a Resource Group or Subscription, depending on Parameter Set.
Examples
Example 1 Get Specific IoT Central Application.
Get-AzIotCentralApp -ResourceGroupName "MyResourceGroupName" -Name "MyAppResourceName"
ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft
.IoTCentral/IoTApps/MyAppResourceName
Name : MyAppResourceName
Type : Microsoft.IoTCentral/IoTApps
Location : westus
Tag : {[key, val]}
Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo
ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
DisplayName : My 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
Gets the metadata for the specified IoT Central Application.
Example 2 Get IoT Central Applications in Subscription.
Get-AzIotCentralApp
ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft
.IoTCentral/IoTApps/MyAppResourceName
Name : MyAppResourceName
Type : Microsoft.IoTCentral/IoTApps
Location : westus
Tag : {[key, val]}
Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo
ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
DisplayName : My 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
ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName2/providers/Microsoft
.IoTCentral/IoTApps/MyAppResourceName2
Name : MyAppResourceName2
Type : Microsoft.IoTCentral/IoTApps
Location : westus
Tag : {[key, val]}
Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo
ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
DisplayName : My Custom Display Name 2
Subdomain : MyAppSubdomain2
Template : iotc-default@1.0.0
SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ResourceGroupName : MyResourceGroupName2
Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity
Gets the metadata for all the IoT Central Applications in the current Subscription.
Example 3 Get IoT Central Applications in Resource Group.
Get-AzIotCentralApp -ResourceGroupName "MyResourceGroupName"
ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft
.IoTCentral/IoTApps/MyAppResourceName
Name : MyAppResourceName
Type : Microsoft.IoTCentral/IoTApps
Location : westus
Tag : {[key, val]}
Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo
ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
DisplayName : My 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
ResourceId : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/MyResourceGroupName/providers/Microsoft
.IoTCentral/IoTApps/MyAppResourceName2
Name : MyAppResourceName2
Type : Microsoft.IoTCentral/IoTApps
Location : westus
Tag : {[key, val]}
Sku : Microsoft.Azure.Commands.IotCentral.Models.PSIotCentralAppSkuInfo
ApplicationId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
DisplayName : My Custom Display Name 2
Subdomain : MyAppSubdomain2
Template : iotc-default@1.0.0
SubscriptionId : XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ResourceGroupName : MyResourceGroupName
Identity : Microsoft.Azure.Management.IotCentral.Models.SystemAssignedServiceIdentity
Gets the metadata for all IoT Central Applications in the provided Resource Group.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Name of the Iot Central Application Resource.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Name of the Resource Group.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
Iot Central Application Resource Id.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |