Azure Native

v1.78.0 published on Wednesday, Sep 14, 2022 by Pulumi

getDigitalTwin

The description of the DigitalTwins service. API Version: 2020-12-01.

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:

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:

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.

Type string

The resource type.

Identity Pulumi.AzureNative.DigitalTwins.Outputs.DigitalTwinsIdentityResponse

The managed identity for the DigitalTwinsInstance.

PrivateEndpointConnections List<Pulumi.AzureNative.DigitalTwins.Outputs.PrivateEndpointConnectionResponse>
PublicNetworkAccess string

Public network access for the DigitalTwinsInstance.

Tags Dictionary<string, string>

The resource tags.

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.

Type string

The resource type.

Identity DigitalTwinsIdentityResponse

The managed identity for the DigitalTwinsInstance.

PrivateEndpointConnections []PrivateEndpointConnectionResponse
PublicNetworkAccess string

Public network access for the DigitalTwinsInstance.

Tags map[string]string

The resource tags.

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.

type String

The resource type.

identity DigitalTwinsIdentityResponse

The managed identity for the DigitalTwinsInstance.

privateEndpointConnections List<PrivateEndpointConnectionResponse>
publicNetworkAccess String

Public network access for the DigitalTwinsInstance.

tags Map<String,String>

The resource tags.

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.

type string

The resource type.

identity DigitalTwinsIdentityResponse

The managed identity for the DigitalTwinsInstance.

privateEndpointConnections PrivateEndpointConnectionResponse[]
publicNetworkAccess string

Public network access for the DigitalTwinsInstance.

tags {[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_time str

Time when DigitalTwinsInstance was updated.

location str

The resource location.

name str

The resource name.

provisioning_state str

The provisioning state.

type str

The resource type.

identity DigitalTwinsIdentityResponse

The managed identity for the DigitalTwinsInstance.

private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
public_network_access str

Public network access for the DigitalTwinsInstance.

tags Mapping[str, str]

The resource tags.

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.

type String

The resource type.

identity Property Map

The managed identity for the DigitalTwinsInstance.

privateEndpointConnections List<Property Map>
publicNetworkAccess String

Public network access for the DigitalTwinsInstance.

tags Map<String>

The resource tags.

Supporting Types

ConnectionPropertiesResponsePrivateEndpoint

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.

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. Only SystemAssigned is supported.

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. Only SystemAssigned is supported.

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. Only SystemAssigned is supported.

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. Only SystemAssigned is supported.

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. Only SystemAssigned is supported.

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. Only SystemAssigned is supported.

PrivateEndpointConnectionResponse

Id string

The resource identifier.

Name string

The resource name.

Properties Pulumi.AzureNative.DigitalTwins.Inputs.PrivateEndpointConnectionResponseProperties
Type string

The resource type.

Id string

The resource identifier.

Name string

The resource name.

Properties PrivateEndpointConnectionResponseProperties
Type string

The resource type.

id String

The resource identifier.

name String

The resource name.

properties PrivateEndpointConnectionResponseProperties
type String

The resource type.

id string

The resource identifier.

name string

The resource name.

properties PrivateEndpointConnectionResponseProperties
type string

The resource type.

id str

The resource identifier.

name str

The resource name.

properties PrivateEndpointConnectionResponseProperties
type str

The resource type.

id String

The resource identifier.

name String

The resource name.

properties Property Map
type String

The resource type.

PrivateEndpointConnectionResponseProperties

provisioningState String

The provisioning state.

groupIds List<String>

The list of group ids for the private endpoint connection.

privateEndpoint Property Map
privateLinkServiceConnectionState Property Map

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0