Get-AzDigitalTwinsInstance
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.
Get DigitalTwinsInstances resource.
Syntax
List (Default)
Get-AzDigitalTwinsInstance
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
List1
Get-AzDigitalTwinsInstance
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzDigitalTwinsInstance
-ResourceGroupName <String>
-ResourceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzDigitalTwinsInstance
-InputObject <IDigitalTwinsIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Get DigitalTwinsInstances resource.
Examples
Example 1: List DigitalTwinsInstances resource.
Get-AzDigitalTwinsInstance
Name Location ResourceGroupName
---- -------- -----------------
azps-digitaltwins-instance eastus azps_test_group
azps-digitaltwins-instance-2 eastus azps_test_group
List DigitalTwinsInstances resource.
Example 2: Get DigitalTwinsInstances resource by ResourceGroup.
Get-AzDigitalTwinsInstance -ResourceGroupName azps_test_group
Name Location ResourceGroupName
---- -------- -----------------
azps-digitaltwins-instance eastus azps_test_group
azps-digitaltwins-instance-2 eastus azps_test_group
Get DigitalTwinsInstances resource by ResourceGroup.
Example 3: Get DigitalTwinsInstances resource by Instance Name.
Get-AzDigitalTwinsInstance -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance
CreatedTime : 2025-06-06 09:44:17 AM
HostName : azps-digitaltwins-instance.api.eus.digitaltwins.azure.net
Id : /subscriptions/{subId}/resourceGroups/azps_test_group/providers/Microsoft.DigitalTwins/digitalTwinsInstances/azps-digitaltwins-instance
IdentityPrincipalId : 6463ae74-a748-4f95-acf9-7d76e1d343b3
IdentityTenantId : 213e87ed-8e08-4eb4-a63c-c073058f7b00
IdentityType : SystemAssigned
LastUpdatedTime : 2025-06-06 09:45:03 AM
Location : eastus
Name : azps-digitaltwins-instance
PrivateEndpointConnection : {}
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
ResourceGroupName : azps_test_group
SystemDataCreatedAt : 2025-06-06 09:44:15 AM
SystemDataCreatedBy : xxxxx.xxxxx@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 2025-06-06 09:44:15 AM
SystemDataLastModifiedBy : xxxxx.xxxxx@microsoft.com
SystemDataLastModifiedByType : User
Tag : {
}
Type : Microsoft.DigitalTwins/digitalTwinsInstances
Get DigitalTwinsInstances resource by Instance Name.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | 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 |
-InputObject
Identity Parameter
Parameter properties
| Type: | IDigitalTwinsIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the resource group that contains the DigitalTwinsInstance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
List1
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceName
The name of the DigitalTwinsInstance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SubscriptionId
The subscription identifier.
Parameter properties
| Type: | String[] |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
List
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
List1
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Get
| 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.
