Interface IotHubDescription


public interface IotHubDescription
An immutable client-side representation of IotHubDescription.
  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.
    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.
    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.
    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.
    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.
    • etag

      String etag()
      Gets the etag property: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
      Returns:
      the etag value.
    • properties

      IotHubProperties properties()
      Gets the properties property: IotHub properties.
      Returns:
      the properties value.
    • sku

      Gets the sku property: IotHub SKU info.
      Returns:
      the sku value.
    • identity

      ArmIdentity identity()
      Gets the identity property: The managed identities for the IotHub.
      Returns:
      the identity value.
    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: The system meta data relating to this resource.
      Returns:
      the systemData value.
    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.
    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.
    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.
    • innerModel

      Gets the inner com.azure.resourcemanager.iothub.fluent.models.IotHubDescriptionInner object.
      Returns:
      the inner object.
    • update

      Begins update for the IotHubDescription resource.
      Returns:
      the stage of resource update.
    • refresh

      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.
    • refresh

      IotHubDescription refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.
    • listKeys

      com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRule> listKeys()
      Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security

      Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

      Returns:
      the security metadata for an IoT hub as paginated response with PagedIterable.
      Throws:
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listKeys

      com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRule> listKeys(com.azure.core.util.Context context)
      Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security

      Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      the security metadata for an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • exportDevices

      JobResponse exportDevices(ExportDevicesRequest exportDevicesParameters)
      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

      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.

      Parameters:
      exportDevicesParameters - The parameters that specify the export devices operation.
      Returns:
      the properties of the Job Response object.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • exportDevicesWithResponse

      com.azure.core.http.rest.Response<JobResponse> exportDevicesWithResponse(ExportDevicesRequest exportDevicesParameters, com.azure.core.util.Context context)
      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

      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.

      Parameters:
      exportDevicesParameters - The parameters that specify the export devices operation.
      context - The context to associate with this operation.
      Returns:
      the properties of the Job Response object along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • importDevices

      JobResponse importDevices(ImportDevicesRequest importDevicesParameters)
      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

      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.

      Parameters:
      importDevicesParameters - The parameters that specify the import devices operation.
      Returns:
      the properties of the Job Response object.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • importDevicesWithResponse

      com.azure.core.http.rest.Response<JobResponse> importDevicesWithResponse(ImportDevicesRequest importDevicesParameters, com.azure.core.util.Context context)
      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

      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.

      Parameters:
      importDevicesParameters - The parameters that specify the import devices operation.
      context - The context to associate with this operation.
      Returns:
      the properties of the Job Response object along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.