azure.mgmt.digitaltwins.models module¶

class azure.mgmt.digitaltwins.models.AuthenticationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified.

IDENTITY_BASED = 'IdentityBased'¶

KEY_BASED = 'KeyBased'¶

class azure.mgmt.digitaltwins.models.AzureDataExplorerConnectionProperties(*, adx_resource_id: str, adx_endpoint_uri: str, adx_database_name: str, event_hub_endpoint_uri: str, event_hub_entity_path: str, event_hub_namespace_resource_id: str, identity: _models.ManagedIdentityReference | None = None, adx_table_name: str = 'AdtPropertyEvents', adx_twin_lifecycle_events_table_name: str | None = None, adx_relationship_lifecycle_events_table_name: str | None = None, event_hub_consumer_group: str = '$Default', record_property_and_item_removals: str | _models.RecordPropertyAndItemRemovals = 'false', **kwargs: Any)[source]¶

Bases: TimeSeriesDatabaseConnectionProperties

Properties of a time series database connection to Azure Data Explorer with data being sent via an EventHub.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

connection_type (str or ConnectionType) – The type of time series connection resource. Required. “AzureDataExplorer”
provisioning_state (str or TimeSeriesDatabaseConnectionState) – The provisioning state. Known values are: “Provisioning”, “Deleting”, “Updating”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, “Warning”, “Suspending”, “Restoring”, “Moving”, and “Disabled”.
identity (ManagedIdentityReference) – Managed identity properties for the time series database connection resource.
adx_resource_id (str) – The resource ID of the Azure Data Explorer cluster. Required.
adx_endpoint_uri (str) – The URI of the Azure Data Explorer endpoint. Required.
adx_database_name (str) – The name of the Azure Data Explorer database. Required.
adx_table_name (str) – The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
adx_twin_lifecycle_events_table_name (str) – The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
adx_relationship_lifecycle_events_table_name (str) – The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
event_hub_endpoint_uri (str) – The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://. Required.
event_hub_entity_path (str) – The EventHub name in the EventHub namespace for identity-based authentication. Required.
event_hub_namespace_resource_id (str) – The resource ID of the EventHub namespace. Required.
event_hub_consumer_group (str) – The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
record_property_and_item_removals (str or RecordPropertyAndItemRemovals) – Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to ‘true’. Setting this property to ‘true’ will generate an additional column in the property events table in ADX. Known values are: “true” and “false”.

Keyword Arguments:

identity (ManagedIdentityReference) – Managed identity properties for the time series database connection resource.
adx_resource_id (str) – The resource ID of the Azure Data Explorer cluster. Required.
adx_endpoint_uri (str) – The URI of the Azure Data Explorer endpoint. Required.
adx_database_name (str) – The name of the Azure Data Explorer database. Required.
adx_table_name (str) – The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
adx_twin_lifecycle_events_table_name (str) – The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
adx_relationship_lifecycle_events_table_name (str) – The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
event_hub_endpoint_uri (str) – The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://. Required.
event_hub_entity_path (str) – The EventHub name in the EventHub namespace for identity-based authentication. Required.
event_hub_namespace_resource_id (str) – The resource ID of the EventHub namespace. Required.
event_hub_consumer_group (str) – The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
record_property_and_item_removals (str or RecordPropertyAndItemRemovals) – Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to ‘true’. Setting this property to ‘true’ will generate an additional column in the property events table in ADX. Known values are: “true” and “false”.

class azure.mgmt.digitaltwins.models.CheckNameRequest(*, name: str, **kwargs: Any)[source]¶

Bases: Model

The result returned from a database check name availability request.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

name (str) – Resource name. Required.
type (str) – The type of resource, for instance Microsoft.DigitalTwins/digitalTwinsInstances. Required. Default value is “Microsoft.DigitalTwins/digitalTwinsInstances”.

Keyword Arguments:

name (str) – Resource name. Required.

type = 'Microsoft.DigitalTwins/digitalTwinsInstances'¶

class azure.mgmt.digitaltwins.models.CheckNameResult(*, name_available: bool | None = None, message: str | None = None, reason: str | _models.Reason | None = None, **kwargs: Any)[source]¶

Bases: Model

The result returned from a check name availability request.

Variables:

name_available (bool) – Specifies a Boolean value that indicates if the name is available.
message (str) – Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
reason (str or Reason) – Message providing the reason why the given name is invalid. Known values are: “Invalid” and “AlreadyExists”.

Keyword Arguments:

name_available (bool) – Specifies a Boolean value that indicates if the name is available.
message (str) – Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
reason (str or Reason) – Message providing the reason why the given name is invalid. Known values are: “Invalid” and “AlreadyExists”.

class azure.mgmt.digitaltwins.models.CleanupConnectionArtifacts(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

CleanupConnectionArtifacts.

FALSE = 'false'¶

TRUE = 'true'¶

class azure.mgmt.digitaltwins.models.ConnectionProperties(*, private_endpoint: _models.PrivateEndpoint | None = None, group_ids: List[str] | None = None, private_link_service_connection_state: _models.ConnectionPropertiesPrivateLinkServiceConnectionState | None = None, **kwargs: Any)[source]¶

Bases: Model

The properties of a private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provisioning_state (str or ConnectionPropertiesProvisioningState) – The provisioning state. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.
private_endpoint (PrivateEndpoint) – The private endpoint.
group_ids (list[str]) – The list of group ids for the private endpoint connection.
private_link_service_connection_state (ConnectionPropertiesPrivateLinkServiceConnectionState) – The connection state.

Keyword Arguments:

private_endpoint (PrivateEndpoint) – The private endpoint.
group_ids (list[str]) – The list of group ids for the private endpoint connection.
private_link_service_connection_state (ConnectionPropertiesPrivateLinkServiceConnectionState) – The connection state.

class azure.mgmt.digitaltwins.models.ConnectionPropertiesPrivateLinkServiceConnectionState(*, status: str | _models.PrivateLinkServiceConnectionStatus, description: str, actions_required: str | None = None, **kwargs: Any)[source]¶

Bases: ConnectionState

The connection state.

All required parameters must be populated in order to send to server.

Variables:

status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.
description (str) – The description for the current state of a private endpoint connection. Required.
actions_required (str) – Actions required for a private endpoint connection.

Keyword Arguments:

status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.
description (str) – The description for the current state of a private endpoint connection. Required.
actions_required (str) – Actions required for a private endpoint connection.

class azure.mgmt.digitaltwins.models.ConnectionPropertiesProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The provisioning state.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.digitaltwins.models.ConnectionState(*, status: str | _models.PrivateLinkServiceConnectionStatus, description: str, actions_required: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The current state of a private endpoint connection.

All required parameters must be populated in order to send to server.

Variables:

status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.
description (str) – The description for the current state of a private endpoint connection. Required.
actions_required (str) – Actions required for a private endpoint connection.

Keyword Arguments:

status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.
description (str) – The description for the current state of a private endpoint connection. Required.
actions_required (str) – Actions required for a private endpoint connection.

class azure.mgmt.digitaltwins.models.ConnectionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of time series connection resource.

AZURE_DATA_EXPLORER = 'AzureDataExplorer'¶

class azure.mgmt.digitaltwins.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.digitaltwins.models.DigitalTwinsDescription(*, location: str, tags: Dict[str, str] | None = None, identity: _models.DigitalTwinsIdentity | None = None, private_endpoint_connections: List[_models.PrivateEndpointConnection] | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, **kwargs: Any)[source]¶

Bases: DigitalTwinsResource

The description of the DigitalTwins service.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
location (str) – The resource location. Required.
tags (dict[str, str]) – The resource tags.
identity (DigitalTwinsIdentity) – The managed identity for the DigitalTwinsInstance.
system_data (SystemData) – Metadata pertaining to creation and last modification of the DigitalTwinsInstance.
created_time (datetime) – Time when DigitalTwinsInstance was created.
last_updated_time (datetime) – Time when DigitalTwinsInstance was updated.
provisioning_state (str or ProvisioningState) – The provisioning state. Known values are: “Provisioning”, “Deleting”, “Updating”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, “Warning”, “Suspending”, “Restoring”, and “Moving”.
host_name (str) – Api endpoint to work with DigitalTwinsInstance.
private_endpoint_connections (list[PrivateEndpointConnection]) – The private endpoint connections.
public_network_access (str or PublicNetworkAccess) – Public network access for the DigitalTwinsInstance. Known values are: “Enabled” and “Disabled”.

Keyword Arguments:

location (str) – The resource location. Required.
tags (dict[str, str]) – The resource tags.
identity (DigitalTwinsIdentity) – The managed identity for the DigitalTwinsInstance.
private_endpoint_connections (list[PrivateEndpointConnection]) – The private endpoint connections.
public_network_access (str or PublicNetworkAccess) – Public network access for the DigitalTwinsInstance. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.digitaltwins.models.DigitalTwinsDescriptionListResult(*, next_link: str | None = None, value: List[_models.DigitalTwinsDescription] | None = None, **kwargs: Any)[source]¶

Bases: Model

A list of DigitalTwins description objects with a next link.

Variables:

next_link (str) – The link used to get the next page of DigitalTwins description objects.
value (list[DigitalTwinsDescription]) – A list of DigitalTwins description objects.

Keyword Arguments:

next_link (str) – The link used to get the next page of DigitalTwins description objects.
value (list[DigitalTwinsDescription]) – A list of DigitalTwins description objects.

class azure.mgmt.digitaltwins.models.DigitalTwinsEndpointResource(*, properties: _models.DigitalTwinsEndpointResourceProperties, **kwargs: Any)[source]¶

Bases: ExternalResource

DigitalTwinsInstance endpoint resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – The resource identifier.
name (str) – Extension resource name.
type (str) – The resource type.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (DigitalTwinsEndpointResourceProperties) – DigitalTwinsInstance endpoint resource properties. Required.

Keyword Arguments:

properties (DigitalTwinsEndpointResourceProperties) – DigitalTwinsInstance endpoint resource properties. Required.

class azure.mgmt.digitaltwins.models.DigitalTwinsEndpointResourceListResult(*, next_link: str | None = None, value: List[_models.DigitalTwinsEndpointResource] | None = None, **kwargs: Any)[source]¶

Bases: Model

A list of DigitalTwinsInstance Endpoints with a next link.

Variables:

next_link (str) – The link used to get the next page of DigitalTwinsInstance Endpoints.
value (list[DigitalTwinsEndpointResource]) – A list of DigitalTwinsInstance Endpoints.

Keyword Arguments:

next_link (str) – The link used to get the next page of DigitalTwinsInstance Endpoints.
value (list[DigitalTwinsEndpointResource]) – A list of DigitalTwinsInstance Endpoints.

class azure.mgmt.digitaltwins.models.DigitalTwinsEndpointResourceProperties(*, authentication_type: str | _models.AuthenticationType | None = None, dead_letter_secret: str | None = None, dead_letter_uri: str | None = None, identity: _models.ManagedIdentityReference | None = None, **kwargs: Any)[source]¶

Bases: Model

Properties related to Digital Twins Endpoint.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EventGrid, EventHub, ServiceBus

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

endpoint_type (str or EndpointType) – The type of Digital Twins endpoint. Required. Known values are: “EventHub”, “EventGrid”, and “ServiceBus”.
provisioning_state (str or EndpointProvisioningState) – The provisioning state. Known values are: “Provisioning”, “Deleting”, “Updating”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, “Warning”, “Suspending”, “Restoring”, “Moving”, and “Disabled”.
created_time (datetime) – Time when the Endpoint was added to DigitalTwinsInstance.
authentication_type (str or AuthenticationType) – Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified. Known values are: “KeyBased” and “IdentityBased”.
dead_letter_secret (str) – Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri (str) – Dead letter storage URL for identity-based authentication.
identity (ManagedIdentityReference) – Managed identity properties for the endpoint.

Keyword Arguments:

authentication_type (str or AuthenticationType) – Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified. Known values are: “KeyBased” and “IdentityBased”.
dead_letter_secret (str) – Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri (str) – Dead letter storage URL for identity-based authentication.
identity (ManagedIdentityReference) – Managed identity properties for the endpoint.

class azure.mgmt.digitaltwins.models.DigitalTwinsIdentity(*, type: str | _models.DigitalTwinsIdentityType | None = None, user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, **kwargs: Any)[source]¶

Bases: Model

The managed identity for the DigitalTwinsInstance.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

type (str or DigitalTwinsIdentityType) – The type of Managed Identity used by the DigitalTwinsInstance. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
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.
user_assigned_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}’. # pylint: disable=line-too-long: .

Keyword Arguments:

type (str or DigitalTwinsIdentityType) – The type of Managed Identity used by the DigitalTwinsInstance. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
user_assigned_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}’. # pylint: disable=line-too-long: .

class azure.mgmt.digitaltwins.models.DigitalTwinsIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of Managed Identity used by the DigitalTwinsInstance.

NONE = 'None'¶

SYSTEM_ASSIGNED = 'SystemAssigned'¶

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned'¶

USER_ASSIGNED = 'UserAssigned'¶

class azure.mgmt.digitaltwins.models.DigitalTwinsPatchDescription(*, tags: Dict[str, str] | None = None, identity: _models.DigitalTwinsIdentity | None = None, properties: _models.DigitalTwinsPatchProperties | None = None, **kwargs: Any)[source]¶

Bases: Model

The description of the DigitalTwins service.

Variables:

tags (dict[str, str]) – Instance patch properties.
identity (DigitalTwinsIdentity) – The managed identity for the DigitalTwinsInstance.
properties (DigitalTwinsPatchProperties) – Properties for the DigitalTwinsInstance.

Keyword Arguments:

tags (dict[str, str]) – Instance patch properties.
identity (DigitalTwinsIdentity) – The managed identity for the DigitalTwinsInstance.
properties (DigitalTwinsPatchProperties) – Properties for the DigitalTwinsInstance.

class azure.mgmt.digitaltwins.models.DigitalTwinsPatchProperties(*, public_network_access: str | _models.PublicNetworkAccess | None = None, **kwargs: Any)[source]¶

Bases: Model

The properties of a DigitalTwinsInstance.

Variables:: public_network_access (str or PublicNetworkAccess) – Public network access for the DigitalTwinsInstance. Known values are: “Enabled” and “Disabled”.
Keyword Arguments:: public_network_access (str or PublicNetworkAccess) – Public network access for the DigitalTwinsInstance. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.digitaltwins.models.DigitalTwinsResource(*, location: str, tags: Dict[str, str] | None = None, identity: _models.DigitalTwinsIdentity | None = None, **kwargs: Any)[source]¶

Bases: Model

The common properties of a DigitalTwinsInstance.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
location (str) – The resource location. Required.
tags (dict[str, str]) – The resource tags.
identity (DigitalTwinsIdentity) – The managed identity for the DigitalTwinsInstance.
system_data (SystemData) – Metadata pertaining to creation and last modification of the DigitalTwinsInstance.

Keyword Arguments:

location (str) – The resource location. Required.
tags (dict[str, str]) – The resource tags.
identity (DigitalTwinsIdentity) – The managed identity for the DigitalTwinsInstance.

class azure.mgmt.digitaltwins.models.EndpointProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The provisioning state.

CANCELED = 'Canceled'¶

DELETED = 'Deleted'¶

DELETING = 'Deleting'¶

DISABLED = 'Disabled'¶

FAILED = 'Failed'¶

MOVING = 'Moving'¶

PROVISIONING = 'Provisioning'¶

RESTORING = 'Restoring'¶

SUCCEEDED = 'Succeeded'¶

SUSPENDING = 'Suspending'¶

UPDATING = 'Updating'¶

WARNING = 'Warning'¶

class azure.mgmt.digitaltwins.models.EndpointType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of Digital Twins endpoint.

EVENT_GRID = 'EventGrid'¶

EVENT_HUB = 'EventHub'¶

SERVICE_BUS = 'ServiceBus'¶

class azure.mgmt.digitaltwins.models.ErrorDefinition(**kwargs: Any)[source]¶

Bases: Model

Error definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str) – Service specific error code which serves as the substatus for the HTTP error code.
message (str) – Description of the error.
details (list[ErrorDefinition]) – Internal error details.

class azure.mgmt.digitaltwins.models.ErrorResponse(*, error: _models.ErrorDefinition | None = None, **kwargs: Any)[source]¶

Bases: Model

Error response.

Variables:: error (ErrorDefinition) – Error description.
Keyword Arguments:: error (ErrorDefinition) – Error description.

class azure.mgmt.digitaltwins.models.EventGrid(*, topic_endpoint: str, access_key1: str, authentication_type: str | _models.AuthenticationType | None = None, dead_letter_secret: str | None = None, dead_letter_uri: str | None = None, identity: _models.ManagedIdentityReference | None = None, access_key2: str | None = None, **kwargs: Any)[source]¶

Bases: DigitalTwinsEndpointResourceProperties

Properties related to EventGrid.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

endpoint_type (str or EndpointType) – The type of Digital Twins endpoint. Required. Known values are: “EventHub”, “EventGrid”, and “ServiceBus”.
provisioning_state (str or EndpointProvisioningState) – The provisioning state. Known values are: “Provisioning”, “Deleting”, “Updating”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, “Warning”, “Suspending”, “Restoring”, “Moving”, and “Disabled”.
created_time (datetime) – Time when the Endpoint was added to DigitalTwinsInstance.
authentication_type (str or AuthenticationType) – Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified. Known values are: “KeyBased” and “IdentityBased”.
dead_letter_secret (str) – Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri (str) – Dead letter storage URL for identity-based authentication.
identity (ManagedIdentityReference) – Managed identity properties for the endpoint.
topic_endpoint (str) – EventGrid Topic Endpoint. Required.
access_key1 (str) – EventGrid secondary accesskey. Will be obfuscated during read. Required.
access_key2 (str) – EventGrid secondary accesskey. Will be obfuscated during read.

Keyword Arguments:

authentication_type (str or AuthenticationType) – Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified. Known values are: “KeyBased” and “IdentityBased”.
dead_letter_secret (str) – Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri (str) – Dead letter storage URL for identity-based authentication.
identity (ManagedIdentityReference) – Managed identity properties for the endpoint.
topic_endpoint (str) – EventGrid Topic Endpoint. Required.
access_key1 (str) – EventGrid secondary accesskey. Will be obfuscated during read. Required.
access_key2 (str) – EventGrid secondary accesskey. Will be obfuscated during read.

class azure.mgmt.digitaltwins.models.EventHub(*, authentication_type: str | _models.AuthenticationType | None = None, dead_letter_secret: str | None = None, dead_letter_uri: str | None = None, identity: _models.ManagedIdentityReference | None = None, connection_string_primary_key: str | None = None, connection_string_secondary_key: str | None = None, endpoint_uri: str | None = None, entity_path: str | None = None, **kwargs: Any)[source]¶

Bases: DigitalTwinsEndpointResourceProperties

Properties related to EventHub.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

endpoint_type (str or EndpointType) – The type of Digital Twins endpoint. Required. Known values are: “EventHub”, “EventGrid”, and “ServiceBus”.
provisioning_state (str or EndpointProvisioningState) – The provisioning state. Known values are: “Provisioning”, “Deleting”, “Updating”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, “Warning”, “Suspending”, “Restoring”, “Moving”, and “Disabled”.
created_time (datetime) – Time when the Endpoint was added to DigitalTwinsInstance.
authentication_type (str or AuthenticationType) – Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified. Known values are: “KeyBased” and “IdentityBased”.
dead_letter_secret (str) – Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri (str) – Dead letter storage URL for identity-based authentication.
identity (ManagedIdentityReference) – Managed identity properties for the endpoint.
connection_string_primary_key (str) – PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connection_string_secondary_key (str) – SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
endpoint_uri (str) – The URL of the EventHub namespace for identity-based authentication. It must include the protocol ‘sb://’.
entity_path (str) – The EventHub name in the EventHub namespace for identity-based authentication.

Keyword Arguments:

authentication_type (str or AuthenticationType) – Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified. Known values are: “KeyBased” and “IdentityBased”.
dead_letter_secret (str) – Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri (str) – Dead letter storage URL for identity-based authentication.
identity (ManagedIdentityReference) – Managed identity properties for the endpoint.
connection_string_primary_key (str) – PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connection_string_secondary_key (str) – SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
endpoint_uri (str) – The URL of the EventHub namespace for identity-based authentication. It must include the protocol ‘sb://’.
entity_path (str) – The EventHub name in the EventHub namespace for identity-based authentication.

class azure.mgmt.digitaltwins.models.ExternalResource(**kwargs: Any)[source]¶

Bases: Model

Definition of a resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – The resource identifier.
name (str) – Extension resource name.
type (str) – The resource type.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

class azure.mgmt.digitaltwins.models.GroupIdInformation(*, properties: _models.GroupIdInformationProperties, id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The group information for creating a private endpoint on Digital Twin.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

properties (GroupIdInformationProperties) – The group information properties. Required.
id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.

Keyword Arguments:

properties (GroupIdInformationProperties) – The group information properties. Required.
id (str) – The resource identifier.

class azure.mgmt.digitaltwins.models.GroupIdInformationProperties(*, group_id: str | None = None, required_members: List[str] | None = None, required_zone_names: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

The properties for a group information object.

Variables:

group_id (str) – The group id.
required_members (list[str]) – The required members for a specific group id.
required_zone_names (list[str]) – The required DNS zones for a specific group id.

Keyword Arguments:

group_id (str) – The group id.
required_members (list[str]) – The required members for a specific group id.
required_zone_names (list[str]) – The required DNS zones for a specific group id.

class azure.mgmt.digitaltwins.models.GroupIdInformationResponse(*, value: List[_models.GroupIdInformation] | None = None, **kwargs: Any)[source]¶

Bases: Model

The available private link resources for a Digital Twin.

Variables:: value (list[GroupIdInformation]) – The list of available private link resources for a Digital Twin.
Keyword Arguments:: value (list[GroupIdInformation]) – The list of available private link resources for a Digital Twin.

class azure.mgmt.digitaltwins.models.IdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of managed identity used.

SYSTEM_ASSIGNED = 'SystemAssigned'¶

USER_ASSIGNED = 'UserAssigned'¶

class azure.mgmt.digitaltwins.models.ManagedIdentityReference(*, type: str | _models.IdentityType | None = None, user_assigned_identity: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The properties of the Managed Identity.

Variables:

type (str or IdentityType) – The type of managed identity used. Known values are: “SystemAssigned” and “UserAssigned”.
user_assigned_identity (str) – The user identity ARM resource id if the managed identity type is ‘UserAssigned’.

Keyword Arguments:

type (str or IdentityType) – The type of managed identity used. Known values are: “SystemAssigned” and “UserAssigned”.
user_assigned_identity (str) – The user identity ARM resource id if the managed identity type is ‘UserAssigned’.

class azure.mgmt.digitaltwins.models.Operation(*, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]¶

Bases: Model

DigitalTwins service REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

name (str) – Operation name: {provider}/{resource}/{read | write | action | delete}.
display (OperationDisplay) – Operation properties display.
origin (str) – The intended executor of the operation.
is_data_action (bool) – If the operation is a data action (for data plane rbac).
properties (dict[str, JSON]) – Operation properties.

Keyword Arguments:

display (OperationDisplay) – Operation properties display.

class azure.mgmt.digitaltwins.models.OperationDisplay(**kwargs: Any)[source]¶

Bases: Model

The object that represents the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provider (str) – Service provider: Microsoft DigitalTwins.
resource (str) – Resource Type: DigitalTwinsInstances.
operation (str) – Name of the operation.
description (str) – Friendly description for the operation.

class azure.mgmt.digitaltwins.models.OperationListResult(*, next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

A list of DigitalTwins service operations. It contains a list of operations and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

next_link (str) – The link used to get the next page of DigitalTwins description objects.
value (list[Operation]) – A list of DigitalTwins operations supported by the Microsoft.DigitalTwins resource provider.

Keyword Arguments:

next_link (str) – The link used to get the next page of DigitalTwins description objects.

class azure.mgmt.digitaltwins.models.PrivateEndpoint(**kwargs: Any)[source]¶

Bases: Model

The private endpoint property of a private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: id (str) – The resource identifier.

class azure.mgmt.digitaltwins.models.PrivateEndpointConnection(*, properties: _models.ConnectionProperties, **kwargs: Any)[source]¶

Bases: Model

The private endpoint connection of a Digital Twin.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.
properties (ConnectionProperties) – The connection properties. Required.
system_data (SystemData) – Metadata pertaining to creation and last modification of the private endpoint connection.

Keyword Arguments:

properties (ConnectionProperties) – The connection properties. Required.

class azure.mgmt.digitaltwins.models.PrivateEndpointConnectionsResponse(*, value: List[_models.PrivateEndpointConnection] | None = None, **kwargs: Any)[source]¶

Bases: Model

The available private link connections for a Digital Twin.

Variables:: value (list[PrivateEndpointConnection]) – The list of available private link connections for a Digital Twin.
Keyword Arguments:: value (list[PrivateEndpointConnection]) – The list of available private link connections for a Digital Twin.

class azure.mgmt.digitaltwins.models.PrivateLinkServiceConnectionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The status of a private endpoint connection.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.digitaltwins.models.ProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The provisioning state.

CANCELED = 'Canceled'¶

DELETED = 'Deleted'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

MOVING = 'Moving'¶

PROVISIONING = 'Provisioning'¶

RESTORING = 'Restoring'¶

SUCCEEDED = 'Succeeded'¶

SUSPENDING = 'Suspending'¶

UPDATING = 'Updating'¶

WARNING = 'Warning'¶

class azure.mgmt.digitaltwins.models.PublicNetworkAccess(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Public network access for the DigitalTwinsInstance.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.digitaltwins.models.Reason(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Message providing the reason why the given name is invalid.

ALREADY_EXISTS = 'AlreadyExists'¶

INVALID = 'Invalid'¶

class azure.mgmt.digitaltwins.models.RecordPropertyAndItemRemovals(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to ‘true’. Setting this property to ‘true’ will generate an additional column in the property events table in ADX.

FALSE = 'false'¶

TRUE = 'true'¶

class azure.mgmt.digitaltwins.models.ServiceBus(*, authentication_type: str | _models.AuthenticationType | None = None, dead_letter_secret: str | None = None, dead_letter_uri: str | None = None, identity: _models.ManagedIdentityReference | None = None, primary_connection_string: str | None = None, secondary_connection_string: str | None = None, endpoint_uri: str | None = None, entity_path: str | None = None, **kwargs: Any)[source]¶

Bases: DigitalTwinsEndpointResourceProperties

Properties related to ServiceBus.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

endpoint_type (str or EndpointType) – The type of Digital Twins endpoint. Required. Known values are: “EventHub”, “EventGrid”, and “ServiceBus”.
provisioning_state (str or EndpointProvisioningState) – The provisioning state. Known values are: “Provisioning”, “Deleting”, “Updating”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, “Warning”, “Suspending”, “Restoring”, “Moving”, and “Disabled”.
created_time (datetime) – Time when the Endpoint was added to DigitalTwinsInstance.
authentication_type (str or AuthenticationType) – Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified. Known values are: “KeyBased” and “IdentityBased”.
dead_letter_secret (str) – Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri (str) – Dead letter storage URL for identity-based authentication.
identity (ManagedIdentityReference) – Managed identity properties for the endpoint.
primary_connection_string (str) – PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondary_connection_string (str) – SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
endpoint_uri (str) – The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol ‘sb://’.
entity_path (str) – The ServiceBus Topic name for identity-based authentication.

Keyword Arguments:

authentication_type (str or AuthenticationType) – Specifies the authentication type being used for connecting to the endpoint. Defaults to ‘KeyBased’. If ‘KeyBased’ is selected, a connection string must be specified (at least the primary connection string). If ‘IdentityBased’ is select, the endpointUri and entityPath properties must be specified. Known values are: “KeyBased” and “IdentityBased”.
dead_letter_secret (str) – Dead letter storage secret for key-based authentication. Will be obfuscated during read.
dead_letter_uri (str) – Dead letter storage URL for identity-based authentication.
identity (ManagedIdentityReference) – Managed identity properties for the endpoint.
primary_connection_string (str) – PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
secondary_connection_string (str) – SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
endpoint_uri (str) – The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol ‘sb://’.
entity_path (str) – The ServiceBus Topic name for identity-based authentication.

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.digitaltwins.models.TimeSeriesDatabaseConnection(*, properties: _models.TimeSeriesDatabaseConnectionProperties | None = None, **kwargs: Any)[source]¶

Bases: ExternalResource

Describes a time series database connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – The resource identifier.
name (str) – Extension resource name.
type (str) – The resource type.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
properties (TimeSeriesDatabaseConnectionProperties) – Properties of a specific time series database connection.

Keyword Arguments:

properties (TimeSeriesDatabaseConnectionProperties) – Properties of a specific time series database connection.

class azure.mgmt.digitaltwins.models.TimeSeriesDatabaseConnectionListResult(*, next_link: str | None = None, value: List[_models.TimeSeriesDatabaseConnection] | None = None, **kwargs: Any)[source]¶

Bases: Model

A pageable list of time series database connection resources.

Variables:

next_link (str) – The link used to get the next page of results.
value (list[TimeSeriesDatabaseConnection]) – A list of time series database connection resources.

Keyword Arguments:

next_link (str) – The link used to get the next page of results.
value (list[TimeSeriesDatabaseConnection]) – A list of time series database connection resources.

class azure.mgmt.digitaltwins.models.TimeSeriesDatabaseConnectionProperties(*, identity: _models.ManagedIdentityReference | None = None, **kwargs: Any)[source]¶

Bases: Model

Properties of a time series database connection resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureDataExplorerConnectionProperties

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

connection_type (str or ConnectionType) – The type of time series connection resource. Required. “AzureDataExplorer”
provisioning_state (str or TimeSeriesDatabaseConnectionState) – The provisioning state. Known values are: “Provisioning”, “Deleting”, “Updating”, “Succeeded”, “Failed”, “Canceled”, “Deleted”, “Warning”, “Suspending”, “Restoring”, “Moving”, and “Disabled”.
identity (ManagedIdentityReference) – Managed identity properties for the time series database connection resource.

Keyword Arguments:

identity (ManagedIdentityReference) – Managed identity properties for the time series database connection resource.

class azure.mgmt.digitaltwins.models.TimeSeriesDatabaseConnectionState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The provisioning state.

CANCELED = 'Canceled'¶

DELETED = 'Deleted'¶

DELETING = 'Deleting'¶

DISABLED = 'Disabled'¶

FAILED = 'Failed'¶

MOVING = 'Moving'¶

PROVISIONING = 'Provisioning'¶

RESTORING = 'Restoring'¶

SUCCEEDED = 'Succeeded'¶

SUSPENDING = 'Suspending'¶

UPDATING = 'Updating'¶

WARNING = 'Warning'¶

class azure.mgmt.digitaltwins.models.UserAssignedIdentity(**kwargs: Any)[source]¶

Bases: Model

The information about the user assigned identity.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

client_id (str) – The client id of the User Assigned Identity Resource.
principal_id (str) – The object id of the User Assigned Identity Resource.