DigitalTwinsDescriptionResource Class

Definition

Namespace:: Azure.ResourceManager.DigitalTwins

Assembly:: Azure.ResourceManager.DigitalTwins.dll

Package:: Azure.ResourceManager.DigitalTwins v1.3.2

Package:: Azure.ResourceManager.DigitalTwins v1.3.0-beta.1

Source:: DigitalTwinsDescriptionResource.cs

Source:: DigitalTwinsDescriptionResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A Class representing a DigitalTwinsDescription along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a DigitalTwinsDescriptionResource from an instance of ArmClient using the GetDigitalTwinsDescriptionResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetDigitalTwinsDescription method.

public class DigitalTwinsDescriptionResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DigitalTwins.DigitalTwinsDescriptionData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DigitalTwins.DigitalTwinsDescriptionData>

public class DigitalTwinsDescriptionResource : Azure.ResourceManager.ArmResource

type DigitalTwinsDescriptionResource = class
    inherit ArmResource
    interface IJsonModel<DigitalTwinsDescriptionData>
    interface IPersistableModel<DigitalTwinsDescriptionData>

type DigitalTwinsDescriptionResource = class
    inherit ArmResource

Public Class DigitalTwinsDescriptionResource
Inherits ArmResource
Implements IJsonModel(Of DigitalTwinsDescriptionData), IPersistableModel(Of DigitalTwinsDescriptionData)

Public Class DigitalTwinsDescriptionResource
Inherits ArmResource

Inheritance: Object

ArmResource
DigitalTwinsDescriptionResource

Implements: IJsonModel<DigitalTwinsDescriptionData> IPersistableModel<DigitalTwinsDescriptionData> IPersistableModel<T>

Constructors

Name	Description
DigitalTwinsDescriptionResource()	Initializes a new instance of the DigitalTwinsDescriptionResource class for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Data	Gets the data representing this Feature.
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
HasData	Gets whether or not the current instance has data.
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

Name	Description
AddTag(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
CanUseTagResource(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)	Generate the resource identifier of a DigitalTwinsDescriptionResource instance.
Delete(WaitUntil, CancellationToken)	Delete a DigitalTwinsInstance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Delete Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
DeleteAsync(WaitUntil, CancellationToken)	Delete a DigitalTwinsInstance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Delete Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
Get(CancellationToken)	Get DigitalTwinsInstances resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
GetAsync(CancellationToken)	Get DigitalTwinsInstances resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetDigitalTwinsEndpointResource(String, CancellationToken)	Get DigitalTwinsInstances Endpoint. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName} Operation Id: DigitalTwinsEndpoint_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsEndpointResource
GetDigitalTwinsEndpointResourceAsync(String, CancellationToken)	Get DigitalTwinsInstances Endpoint. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName} Operation Id: DigitalTwinsEndpoint_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsEndpointResource
GetDigitalTwinsEndpointResources()	Gets a collection of DigitalTwinsEndpointResources in the DigitalTwinsDescription.
GetDigitalTwinsPrivateEndpointConnection(String, CancellationToken)	Get private endpoint connection properties for the given private endpoint. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Operation Id: PrivateEndpointConnections_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsPrivateEndpointConnectionResource
GetDigitalTwinsPrivateEndpointConnectionAsync(String, CancellationToken)	Get private endpoint connection properties for the given private endpoint. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Operation Id: PrivateEndpointConnections_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsPrivateEndpointConnectionResource
GetDigitalTwinsPrivateEndpointConnections()	Gets a collection of DigitalTwinsPrivateEndpointConnectionResources in the DigitalTwinsDescription.
GetDigitalTwinsPrivateLinkResource(String, CancellationToken)	Get the specified private link resource for the given Digital Twin. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources/{resourceId} Operation Id: PrivateLinkResources_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsPrivateLinkResource
GetDigitalTwinsPrivateLinkResourceAsync(String, CancellationToken)	Get the specified private link resource for the given Digital Twin. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateLinkResources/{resourceId} Operation Id: PrivateLinkResources_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsPrivateLinkResource
GetDigitalTwinsPrivateLinkResources()	Gets a collection of DigitalTwinsPrivateLinkResources in the DigitalTwinsDescription.
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
GetTimeSeriesDatabaseConnection(String, CancellationToken)	Get the description of an existing time series database connection. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName} Operation Id: TimeSeriesDatabaseConnections_Get Default Api Version: 2023-01-31 Resource: TimeSeriesDatabaseConnectionResource
GetTimeSeriesDatabaseConnectionAsync(String, CancellationToken)	Get the description of an existing time series database connection. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName} Operation Id: TimeSeriesDatabaseConnections_Get Default Api Version: 2023-01-31 Resource: TimeSeriesDatabaseConnectionResource
GetTimeSeriesDatabaseConnections()	Gets a collection of TimeSeriesDatabaseConnectionResources in the DigitalTwinsDescription.
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Get Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, DigitalTwinsDescriptionPatch, CancellationToken)	Update metadata of DigitalTwinsInstance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Update Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource
UpdateAsync(WaitUntil, DigitalTwinsDescriptionPatch, CancellationToken)	Update metadata of DigitalTwinsInstance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName} Operation Id: DigitalTwins_Update Default Api Version: 2023-01-31 Resource: DigitalTwinsDescriptionResource

Explicit Interface Implementations

Name	Description
IJsonModel<DigitalTwinsDescriptionData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<DigitalTwinsDescriptionData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<DigitalTwinsDescriptionData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<DigitalTwinsDescriptionData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<DigitalTwinsDescriptionData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentCollection objects within the specified scope.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to

Feedback

Was this page helpful?