azure-native.digitaltwins.getDigitalTwin
Explore with Pulumi AI
Get DigitalTwinsInstances resource. Azure REST API version: 2023-01-31.
Other available API versions: 2020-03-01-preview.
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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:digitaltwins:getDigitalTwin
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName The name of the resource group that contains the DigitalTwinsInstance.
- Resource
Name string The name of the DigitalTwinsInstance.
- Resource
Group stringName The name of the resource group that contains the DigitalTwinsInstance.
- Resource
Name string The name of the DigitalTwinsInstance.
- resource
Group StringName The name of the resource group that contains the DigitalTwinsInstance.
- resource
Name String The name of the DigitalTwinsInstance.
- resource
Group stringName The name of the resource group that contains the DigitalTwinsInstance.
- resource
Name string The name of the DigitalTwinsInstance.
- resource_
group_ strname The name of the resource group that contains the DigitalTwinsInstance.
- resource_
name str The name of the DigitalTwinsInstance.
- resource
Group StringName The name of the resource group that contains the DigitalTwinsInstance.
- resource
Name String The name of the DigitalTwinsInstance.
getDigitalTwin Result
The following output properties are available:
- Created
Time string Time when DigitalTwinsInstance was created.
- Host
Name string Api endpoint to work with DigitalTwinsInstance.
- Id string
The resource identifier.
- Last
Updated stringTime Time when DigitalTwinsInstance was updated.
- Location string
The resource location.
- Name string
The resource name.
- Provisioning
State string The provisioning state.
- System
Data Pulumi.Azure Native. Digital Twins. Outputs. System Data Response Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
- Type string
The resource type.
- Identity
Pulumi.
Azure Native. Digital Twins. Outputs. Digital Twins Identity Response The managed identity for the DigitalTwinsInstance.
- Private
Endpoint List<Pulumi.Connections Azure Native. Digital Twins. Outputs. Private Endpoint Connection Response> The private endpoint connections.
- Public
Network stringAccess Public network access for the DigitalTwinsInstance.
- Dictionary<string, string>
The resource tags.
- Created
Time string Time when DigitalTwinsInstance was created.
- Host
Name string Api endpoint to work with DigitalTwinsInstance.
- Id string
The resource identifier.
- Last
Updated stringTime Time when DigitalTwinsInstance was updated.
- Location string
The resource location.
- Name string
The resource name.
- Provisioning
State string The provisioning state.
- System
Data SystemData Response Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
- Type string
The resource type.
- Identity
Digital
Twins Identity Response The managed identity for the DigitalTwinsInstance.
- Private
Endpoint []PrivateConnections Endpoint Connection Response The private endpoint connections.
- Public
Network stringAccess Public network access for the DigitalTwinsInstance.
- map[string]string
The resource tags.
- created
Time String Time when DigitalTwinsInstance was created.
- host
Name String Api endpoint to work with DigitalTwinsInstance.
- id String
The resource identifier.
- last
Updated StringTime Time when DigitalTwinsInstance was updated.
- location String
The resource location.
- name String
The resource name.
- provisioning
State String The provisioning state.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
- type String
The resource type.
- identity
Digital
Twins Identity Response The managed identity for the DigitalTwinsInstance.
- private
Endpoint List<PrivateConnections Endpoint Connection Response> The private endpoint connections.
- public
Network StringAccess Public network access for the DigitalTwinsInstance.
- Map<String,String>
The resource tags.
- created
Time string Time when DigitalTwinsInstance was created.
- host
Name string Api endpoint to work with DigitalTwinsInstance.
- id string
The resource identifier.
- last
Updated stringTime Time when DigitalTwinsInstance was updated.
- location string
The resource location.
- name string
The resource name.
- provisioning
State string The provisioning state.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
- type string
The resource type.
- identity
Digital
Twins Identity Response The managed identity for the DigitalTwinsInstance.
- private
Endpoint PrivateConnections Endpoint Connection Response[] The private endpoint connections.
- public
Network stringAccess Public network access for the DigitalTwinsInstance.
- {[key: string]: string}
The resource tags.
- created_
time str Time when DigitalTwinsInstance was created.
- host_
name str Api endpoint to work with DigitalTwinsInstance.
- id str
The resource identifier.
- last_
updated_ strtime Time when DigitalTwinsInstance was updated.
- location str
The resource location.
- name str
The resource name.
- provisioning_
state str The provisioning state.
- system_
data SystemData Response Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
- type str
The resource type.
- identity
Digital
Twins Identity Response The managed identity for the DigitalTwinsInstance.
- private_
endpoint_ Sequence[Privateconnections Endpoint Connection Response] The private endpoint connections.
- public_
network_ straccess Public network access for the DigitalTwinsInstance.
- Mapping[str, str]
The resource tags.
- created
Time String Time when DigitalTwinsInstance was created.
- host
Name String Api endpoint to work with DigitalTwinsInstance.
- id String
The resource identifier.
- last
Updated StringTime Time when DigitalTwinsInstance was updated.
- location String
The resource location.
- name String
The resource name.
- provisioning
State String The provisioning state.
- system
Data 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.
- private
Endpoint List<Property Map>Connections The private endpoint connections.
- public
Network StringAccess Public network access for the DigitalTwinsInstance.
- Map<String>
The resource tags.
Supporting Types
ConnectionPropertiesResponse
- Provisioning
State string The provisioning state.
- Group
Ids List<string> The list of group ids for the private endpoint connection.
- Private
Endpoint Pulumi.Azure Native. Digital Twins. Inputs. Private Endpoint Response The private endpoint.
- Private
Link Pulumi.Service Connection State Azure Native. Digital Twins. Inputs. Connection Properties Response Private Link Service Connection State The connection state.
- Provisioning
State string The provisioning state.
- Group
Ids []string The list of group ids for the private endpoint connection.
- Private
Endpoint PrivateEndpoint Response The private endpoint.
- Private
Link ConnectionService Connection State Properties Response Private Link Service Connection State The connection state.
- provisioning
State String The provisioning state.
- group
Ids List<String> The list of group ids for the private endpoint connection.
- private
Endpoint PrivateEndpoint Response The private endpoint.
- private
Link ConnectionService Connection State Properties Response Private Link Service Connection State The connection state.
- provisioning
State string The provisioning state.
- group
Ids string[] The list of group ids for the private endpoint connection.
- private
Endpoint PrivateEndpoint Response The private endpoint.
- private
Link ConnectionService Connection State Properties Response Private Link Service Connection State 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 PrivateEndpoint Response The private endpoint.
- private_
link_ Connectionservice_ connection_ state Properties Response Private Link Service Connection State The connection state.
- provisioning
State String The provisioning state.
- group
Ids List<String> The list of group ids for the private endpoint connection.
- private
Endpoint Property Map The private endpoint.
- private
Link Property MapService Connection State 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.
- Actions
Required 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.
- Actions
Required 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.
- actions
Required 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.
- actions
Required 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.
- actions
Required String Actions required for a private endpoint connection.
DigitalTwinsIdentityResponse
- Principal
Id 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
- Tenant
Id 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.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Digital Twins. Inputs. User Assigned Identity Response> 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 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
- Tenant
Id 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.
- User
Assigned map[string]UserIdentities Assigned Identity Response 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 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
- tenant
Id 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.
- user
Assigned Map<String,UserIdentities Assigned Identity Response> 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 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
- tenant
Id 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.
- user
Assigned {[key: string]: UserIdentities Assigned Identity Response} 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_ Mapping[str, Useridentities Assigned Identity Response] 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 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
- tenant
Id 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.
- user
Assigned Map<Property Map>Identities 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.
Azure Native. Digital Twins. Inputs. Connection Properties Response The connection properties.
- System
Data Pulumi.Azure Native. Digital Twins. Inputs. System Data Response 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
Connection
Properties Response The connection properties.
- System
Data SystemData Response 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
Connection
Properties Response The connection properties.
- system
Data SystemData Response 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
Connection
Properties Response The connection properties.
- system
Data SystemData Response 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
Connection
Properties Response The connection properties.
- system_
data SystemData Response 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.
- system
Data 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
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type 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_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
UserAssignedIdentityResponse
- Client
Id string The client id of the User Assigned Identity Resource.
- Principal
Id string The object id of the User Assigned Identity Resource.
- Client
Id string The client id of the User Assigned Identity Resource.
- Principal
Id string The object id of the User Assigned Identity Resource.
- client
Id String The client id of the User Assigned Identity Resource.
- principal
Id String The object id of the User Assigned Identity Resource.
- client
Id string The client id of the User Assigned Identity Resource.
- principal
Id 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.
- client
Id String The client id of the User Assigned Identity Resource.
- principal
Id String The object id of the User Assigned Identity Resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0