IotHubDescriptionResource Class

Definition

Namespace:: Azure.ResourceManager.IotHub

Assembly:: Azure.ResourceManager.IotHub.dll

Package:: Azure.ResourceManager.IotHub v1.1.1

Package:: Azure.ResourceManager.IotHub v1.2.0-beta.3

Source:: IotHubDescriptionResource.cs

Source:: IotHubDescriptionResource.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 an IotHubDescription along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an IotHubDescriptionResource from an instance of ArmClient using the GetIotHubDescriptionResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetIotHubDescription method.

public class IotHubDescriptionResource : Azure.ResourceManager.ArmResource

public class IotHubDescriptionResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotHub.IotHubDescriptionData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotHub.IotHubDescriptionData>

type IotHubDescriptionResource = class
    inherit ArmResource

type IotHubDescriptionResource = class
    inherit ArmResource
    interface IJsonModel<IotHubDescriptionData>
    interface IPersistableModel<IotHubDescriptionData>

Public Class IotHubDescriptionResource
Inherits ArmResource

Public Class IotHubDescriptionResource
Inherits ArmResource
Implements IJsonModel(Of IotHubDescriptionData), IPersistableModel(Of IotHubDescriptionData)

Inheritance: Object

ArmResource
IotHubDescriptionResource

Implements: IJsonModel<IotHubDescriptionData> IPersistableModel<IotHubDescriptionData> IPersistableModel<T>

Constructors

Name	Description
IotHubDescriptionResource()	Initializes a new instance of the IotHubDescriptionResource 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.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Get Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Get Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
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 IotHubDescriptionResource instance.
Delete(WaitUntil, CancellationToken)	Delete an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Delete Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
DeleteAsync(WaitUntil, CancellationToken)	Delete an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Delete Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
ExportDevices(ExportDevicesContent, CancellationToken)	Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices Operation Id: IotHubResource_ExportDevices Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
ExportDevicesAsync(ExportDevicesContent, CancellationToken)	Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices Operation Id: IotHubResource_ExportDevices Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
Get(CancellationToken)	Get the non-security related metadata of an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Get Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetAllIotHubPrivateEndpointGroupInformation()	Gets a collection of IotHubPrivateEndpointGroupInformationResources in the IotHubDescription.
GetAsync(CancellationToken)	Get the non-security related metadata of an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Get Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetEndpointHealth(CancellationToken)	Get the health for routing endpoints. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth Operation Id: IotHubResource_GetEndpointHealth Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetEndpointHealthAsync(CancellationToken)	Get the health for routing endpoints. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth Operation Id: IotHubResource_GetEndpointHealth Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetEventHubConsumerGroupInfo(String, String, CancellationToken)	Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name} Operation Id: IotHubResource_GetEventHubConsumerGroup Default Api Version: 2025-08-01-preview Resource: EventHubConsumerGroupInfoResource
GetEventHubConsumerGroupInfoAsync(String, String, CancellationToken)	Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name} Operation Id: IotHubResource_GetEventHubConsumerGroup Default Api Version: 2025-08-01-preview Resource: EventHubConsumerGroupInfoResource
GetEventHubConsumerGroupInfos(String)	Gets a collection of EventHubConsumerGroupInfoResources in the IotHubDescription.
GetIotHubCertificateDescription(String, CancellationToken)	Returns the certificate. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName} Operation Id: Certificates_Get Default Api Version: 2025-08-01-preview Resource: IotHubCertificateDescriptionResource
GetIotHubCertificateDescriptionAsync(String, CancellationToken)	Returns the certificate. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName} Operation Id: Certificates_Get Default Api Version: 2025-08-01-preview Resource: IotHubCertificateDescriptionResource
GetIotHubCertificateDescriptions()	Gets a collection of IotHubCertificateDescriptionResources in the IotHubDescription.
GetIotHubPrivateEndpointConnection(String, CancellationToken)	Get private endpoint connection properties Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Operation Id: PrivateEndpointConnections_Get Default Api Version: 2025-08-01-preview Resource: IotHubPrivateEndpointConnectionResource
GetIotHubPrivateEndpointConnectionAsync(String, CancellationToken)	Get private endpoint connection properties Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Operation Id: PrivateEndpointConnections_Get Default Api Version: 2025-08-01-preview Resource: IotHubPrivateEndpointConnectionResource
GetIotHubPrivateEndpointConnections()	Gets a collection of IotHubPrivateEndpointConnectionResources in the IotHubDescription.
GetIotHubPrivateEndpointGroupInformation(String, CancellationToken)	Get the specified private link resource for the given IotHub Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId} Operation Id: PrivateLinkResources_Get Default Api Version: 2025-08-01-preview Resource: IotHubPrivateEndpointGroupInformationResource
GetIotHubPrivateEndpointGroupInformationAsync(String, CancellationToken)	Get the specified private link resource for the given IotHub Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId} Operation Id: PrivateLinkResources_Get Default Api Version: 2025-08-01-preview Resource: IotHubPrivateEndpointGroupInformationResource
GetJob(String, CancellationToken)	Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId} Operation Id: IotHubResource_GetJob Default Api Version: 2025-08-01-preview
GetJobAsync(String, CancellationToken)	Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId} Operation Id: IotHubResource_GetJob Default Api Version: 2025-08-01-preview
GetJobs(CancellationToken)	Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs Operation Id: IotHubResource_ListJobs Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetJobsAsync(CancellationToken)	Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs Operation Id: IotHubResource_ListJobs Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetKeys(CancellationToken)	Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys Operation Id: IotHubResource_ListKeys Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetKeysAsync(CancellationToken)	Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys Operation Id: IotHubResource_ListKeys Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetKeysForKeyName(String, CancellationToken)	Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys Operation Id: IotHubResource_GetKeysForKeyName Default Api Version: 2025-08-01-preview
GetKeysForKeyNameAsync(String, CancellationToken)	Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys Operation Id: IotHubResource_GetKeysForKeyName Default Api Version: 2025-08-01-preview
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)
GetQuotaMetrics(CancellationToken)	Get the quota metrics for an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics Operation Id: IotHubResource_GetQuotaMetrics Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetQuotaMetricsAsync(CancellationToken)	Get the quota metrics for an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics Operation Id: IotHubResource_GetQuotaMetrics Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetStats(CancellationToken)	Get the statistics from an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats Operation Id: IotHubResource_GetStats Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetStatsAsync(CancellationToken)	Get the statistics from an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats Operation Id: IotHubResource_GetStats Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
GetValidSkus(CancellationToken)	Get the list of valid SKUs for an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus Operation Id: IotHubResource_GetValidSkus Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
GetValidSkusAsync(CancellationToken)	Get the list of valid SKUs for an IoT hub. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus Operation Id: IotHubResource_GetValidSkus Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
ImportDevices(IotHubImportDevicesContent, CancellationToken)	Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices Operation Id: IotHubResource_ImportDevices Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
ImportDevicesAsync(IotHubImportDevicesContent, CancellationToken)	Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices Operation Id: IotHubResource_ImportDevices Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
ManualFailoverIotHub(WaitUntil, IotHubFailoverContent, CancellationToken)	Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover Operation Id: IotHub_ManualFailover Default Api Version: 2025-08-01-preview
ManualFailoverIotHubAsync(WaitUntil, IotHubFailoverContent, CancellationToken)	Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover Operation Id: IotHub_ManualFailover Default Api Version: 2025-08-01-preview
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Get Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Get Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Get Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Get Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
TestAllRoutes(IotHubTestAllRoutesContent, CancellationToken)	Test all routes configured in this Iot Hub Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall Operation Id: IotHubResource_TestAllRoutes Default Api Version: 2025-08-01-preview
TestAllRoutesAsync(IotHubTestAllRoutesContent, CancellationToken)	Test all routes configured in this Iot Hub Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall Operation Id: IotHubResource_TestAllRoutes Default Api Version: 2025-08-01-preview
TestRoute(IotHubTestRouteContent, CancellationToken)	Test the new route for this Iot Hub Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew Operation Id: IotHubResource_TestRoute Default Api Version: 2025-08-01-preview
TestRouteAsync(IotHubTestRouteContent, CancellationToken)	Test the new route for this Iot Hub Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew Operation Id: IotHubResource_TestRoute Default Api Version: 2025-08-01-preview
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, IotHubDescriptionPatch, CancellationToken)	Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Update Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource
UpdateAsync(WaitUntil, IotHubDescriptionPatch, CancellationToken)	Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName} Operation Id: IotHubResource_Update Default Api Version: 2025-08-01-preview Resource: IotHubDescriptionResource

Explicit Interface Implementations

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