Azure Native v3.1.0, Apr 8 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.digitaltwins.getDigitalTwin

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Using getDigitalTwin

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.

TypeScript
Python
Go
C#
Java
YAML

function getDigitalTwin(args: GetDigitalTwinArgs, opts?: InvokeOptions): Promise<GetDigitalTwinResult>
function getDigitalTwinOutput(args: GetDigitalTwinOutputArgs, opts?: InvokeOptions): Output<GetDigitalTwinResult>

def get_digital_twin(resource_group_name: Optional[str] = None,
                     resource_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetDigitalTwinResult
def get_digital_twin_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     resource_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetDigitalTwinResult]

func LookupDigitalTwin(ctx *Context, args *LookupDigitalTwinArgs, opts ...InvokeOption) (*LookupDigitalTwinResult, error)
func LookupDigitalTwinOutput(ctx *Context, args *LookupDigitalTwinOutputArgs, opts ...InvokeOption) LookupDigitalTwinResultOutput

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

public static class GetDigitalTwin 
{
    public static Task<GetDigitalTwinResult> InvokeAsync(GetDigitalTwinArgs args, InvokeOptions? opts = null)
    public static Output<GetDigitalTwinResult> Invoke(GetDigitalTwinInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDigitalTwinResult> getDigitalTwin(GetDigitalTwinArgs args, InvokeOptions options)
public static Output<GetDigitalTwinResult> getDigitalTwin(GetDigitalTwinArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:digitaltwins:getDigitalTwin
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group that contains the DigitalTwinsInstance.
ResourceName string: The name of the DigitalTwinsInstance.

ResourceGroupName string: The name of the resource group that contains the DigitalTwinsInstance.
ResourceName string: The name of the DigitalTwinsInstance.

resourceGroupName String: The name of the resource group that contains the DigitalTwinsInstance.
resourceName String: The name of the DigitalTwinsInstance.

resourceGroupName string: The name of the resource group that contains the DigitalTwinsInstance.
resourceName string: The name of the DigitalTwinsInstance.

resource_group_name str: The name of the resource group that contains the DigitalTwinsInstance.
resource_name str: The name of the DigitalTwinsInstance.

resourceGroupName String: The name of the resource group that contains the DigitalTwinsInstance.
resourceName String: The name of the DigitalTwinsInstance.

getDigitalTwin Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CreatedTime string: Time when DigitalTwinsInstance was created.
HostName string: Api endpoint to work with DigitalTwinsInstance.
Id string: The resource identifier.
LastUpdatedTime string: Time when DigitalTwinsInstance was updated.
Location string: The resource location.
Name string: The resource name.
ProvisioningState string: The provisioning state.
SystemData Pulumi.AzureNative.DigitalTwins.Outputs.SystemDataResponse: Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
Type string: The resource type.
Identity Pulumi.AzureNative.DigitalTwins.Outputs.DigitalTwinsIdentityResponse: The managed identity for the DigitalTwinsInstance.
PrivateEndpointConnections List<Pulumi.AzureNative.DigitalTwins.Outputs.PrivateEndpointConnectionResponse>: The private endpoint connections.
PublicNetworkAccess string: Public network access for the DigitalTwinsInstance.
Tags Dictionary<string, string>: The resource tags.

AzureApiVersion string: The Azure API version of the resource.
CreatedTime string: Time when DigitalTwinsInstance was created.
HostName string: Api endpoint to work with DigitalTwinsInstance.
Id string: The resource identifier.
LastUpdatedTime string: Time when DigitalTwinsInstance was updated.
Location string: The resource location.
Name string: The resource name.
ProvisioningState string: The provisioning state.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
Type string: The resource type.
Identity DigitalTwinsIdentityResponse: The managed identity for the DigitalTwinsInstance.
PrivateEndpointConnections []PrivateEndpointConnectionResponse: The private endpoint connections.
PublicNetworkAccess string: Public network access for the DigitalTwinsInstance.
Tags map[string]string: The resource tags.

azureApiVersion String: The Azure API version of the resource.
createdTime String: Time when DigitalTwinsInstance was created.
hostName String: Api endpoint to work with DigitalTwinsInstance.
id String: The resource identifier.
lastUpdatedTime String: Time when DigitalTwinsInstance was updated.
location String: The resource location.
name String: The resource name.
provisioningState String: The provisioning state.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
type String: The resource type.
identity DigitalTwinsIdentityResponse: The managed identity for the DigitalTwinsInstance.
privateEndpointConnections List<PrivateEndpointConnectionResponse>: The private endpoint connections.
publicNetworkAccess String: Public network access for the DigitalTwinsInstance.
tags Map<String,String>: The resource tags.

azureApiVersion string: The Azure API version of the resource.
createdTime string: Time when DigitalTwinsInstance was created.
hostName string: Api endpoint to work with DigitalTwinsInstance.
id string: The resource identifier.
lastUpdatedTime string: Time when DigitalTwinsInstance was updated.
location string: The resource location.
name string: The resource name.
provisioningState string: The provisioning state.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
type string: The resource type.
identity DigitalTwinsIdentityResponse: The managed identity for the DigitalTwinsInstance.
privateEndpointConnections PrivateEndpointConnectionResponse[]: The private endpoint connections.
publicNetworkAccess string: Public network access for the DigitalTwinsInstance.
tags {[key: string]: string}: The resource tags.

azure_api_version str: The Azure API version of the resource.
created_time str: Time when DigitalTwinsInstance was created.
host_name str: Api endpoint to work with DigitalTwinsInstance.
id str: The resource identifier.
last_updated_time str: Time when DigitalTwinsInstance was updated.
location str: The resource location.
name str: The resource name.
provisioning_state str: The provisioning state.
system_data SystemDataResponse: Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
type str: The resource type.
identity DigitalTwinsIdentityResponse: The managed identity for the DigitalTwinsInstance.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]: The private endpoint connections.
public_network_access str: Public network access for the DigitalTwinsInstance.
tags Mapping[str, str]: The resource tags.

azureApiVersion String: The Azure API version of the resource.
createdTime String: Time when DigitalTwinsInstance was created.
hostName String: Api endpoint to work with DigitalTwinsInstance.
id String: The resource identifier.
lastUpdatedTime String: Time when DigitalTwinsInstance was updated.
location String: The resource location.
name String: The resource name.
provisioningState String: The provisioning state.
systemData Property Map: Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
type String: The resource type.
identity Property Map: The managed identity for the DigitalTwinsInstance.
privateEndpointConnections List<Property Map>: The private endpoint connections.
publicNetworkAccess String: Public network access for the DigitalTwinsInstance.
tags Map<String>: The resource tags.

Supporting Types

ConnectionPropertiesResponse

ProvisioningState string: The provisioning state.
GroupIds List<string>: The list of group ids for the private endpoint connection.
PrivateEndpoint Pulumi.AzureNative.DigitalTwins.Inputs.PrivateEndpointResponse: The private endpoint.
PrivateLinkServiceConnectionState Pulumi.AzureNative.DigitalTwins.Inputs.ConnectionPropertiesResponsePrivateLinkServiceConnectionState: The connection state.

ProvisioningState string: The provisioning state.
GroupIds []string: The list of group ids for the private endpoint connection.
PrivateEndpoint PrivateEndpointResponse: The private endpoint.
PrivateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState: The connection state.

provisioningState String: The provisioning state.
groupIds List<String>: The list of group ids for the private endpoint connection.
privateEndpoint PrivateEndpointResponse: The private endpoint.
privateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState: The connection state.

provisioningState string: The provisioning state.
groupIds string[]: The list of group ids for the private endpoint connection.
privateEndpoint PrivateEndpointResponse: The private endpoint.
privateLinkServiceConnectionState ConnectionPropertiesResponsePrivateLinkServiceConnectionState: The connection state.

provisioning_state str: The provisioning state.
group_ids Sequence[str]: The list of group ids for the private endpoint connection.
private_endpoint PrivateEndpointResponse: The private endpoint.
private_link_service_connection_state ConnectionPropertiesResponsePrivateLinkServiceConnectionState: The connection state.

provisioningState String: The provisioning state.
groupIds List<String>: The list of group ids for the private endpoint connection.
privateEndpoint Property Map: The private endpoint.
privateLinkServiceConnectionState Property Map: The connection state.

ConnectionPropertiesResponsePrivateLinkServiceConnectionState

Description string: The description for the current state of a private endpoint connection.
Status string: The status of a private endpoint connection.
ActionsRequired string: Actions required for a private endpoint connection.

Description string: The description for the current state of a private endpoint connection.
Status string: The status of a private endpoint connection.
ActionsRequired string: Actions required for a private endpoint connection.

description String: The description for the current state of a private endpoint connection.
status String: The status of a private endpoint connection.
actionsRequired String: Actions required for a private endpoint connection.

description string: The description for the current state of a private endpoint connection.
status string: The status of a private endpoint connection.
actionsRequired string: Actions required for a private endpoint connection.

description str: The description for the current state of a private endpoint connection.
status str: The status of a private endpoint connection.
actions_required str: Actions required for a private endpoint connection.

description String: The description for the current state of a private endpoint connection.
status String: The status of a private endpoint connection.
actionsRequired String: Actions required for a private endpoint connection.

DigitalTwinsIdentityResponse

PrincipalId string: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
TenantId string: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
Type string: The type of Managed Identity used by the DigitalTwinsInstance.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.DigitalTwins.Inputs.UserAssignedIdentityResponse>: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. .

PrincipalId string: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
TenantId string: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
Type string: The type of Managed Identity used by the DigitalTwinsInstance.
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. .

principalId String: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
tenantId String: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
type String: The type of Managed Identity used by the DigitalTwinsInstance.
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. .

principalId string: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
tenantId string: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
type string: The type of Managed Identity used by the DigitalTwinsInstance.
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. .

principal_id str: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
tenant_id str: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
type str: The type of Managed Identity used by the DigitalTwinsInstance.
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. .

principalId String: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
tenantId String: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
type String: The type of Managed Identity used by the DigitalTwinsInstance.
userAssignedIdentities Map<Property Map>: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. .

PrivateEndpointConnectionResponse

Id string: The resource identifier.
Name string: The resource name.
Properties Pulumi.AzureNative.DigitalTwins.Inputs.ConnectionPropertiesResponse: The connection properties.
SystemData Pulumi.AzureNative.DigitalTwins.Inputs.SystemDataResponse: Metadata pertaining to creation and last modification of the private endpoint connection.
Type string: The resource type.

Id string: The resource identifier.
Name string: The resource name.
Properties ConnectionPropertiesResponse: The connection properties.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the private endpoint connection.
Type string: The resource type.

id String: The resource identifier.
name String: The resource name.
properties ConnectionPropertiesResponse: The connection properties.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the private endpoint connection.
type String: The resource type.

id string: The resource identifier.
name string: The resource name.
properties ConnectionPropertiesResponse: The connection properties.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the private endpoint connection.
type string: The resource type.

id str: The resource identifier.
name str: The resource name.
properties ConnectionPropertiesResponse: The connection properties.
system_data SystemDataResponse: Metadata pertaining to creation and last modification of the private endpoint connection.
type str: The resource type.

id String: The resource identifier.
name String: The resource name.
properties Property Map: The connection properties.
systemData Property Map: Metadata pertaining to creation and last modification of the private endpoint connection.
type String: The resource type.

PrivateEndpointResponse

Id string: The resource identifier.

Id string: The resource identifier.

id String: The resource identifier.

id string: The resource identifier.

id str: The resource identifier.

id String: The resource identifier.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

UserAssignedIdentityResponse

ClientId string: The client id of the User Assigned Identity Resource.
PrincipalId string: The object id of the User Assigned Identity Resource.

ClientId string: The client id of the User Assigned Identity Resource.
PrincipalId string: The object id of the User Assigned Identity Resource.

clientId String: The client id of the User Assigned Identity Resource.
principalId String: The object id of the User Assigned Identity Resource.

clientId string: The client id of the User Assigned Identity Resource.
principalId string: The object id of the User Assigned Identity Resource.

client_id str: The client id of the User Assigned Identity Resource.
principal_id str: The object id of the User Assigned Identity Resource.

clientId String: The client id of the User Assigned Identity Resource.
principalId String: The object id of the User Assigned Identity Resource.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.digitaltwins.getDigitalTwin

On this page

On this page

Using getDigitalTwin

getDigitalTwin Result

Supporting Types

ConnectionPropertiesResponse

ConnectionPropertiesResponsePrivateLinkServiceConnectionState

DigitalTwinsIdentityResponse

PrivateEndpointConnectionResponse

PrivateEndpointResponse

SystemDataResponse

UserAssignedIdentityResponse

Package Details

On this page

On this page