azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription.yml

### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription
name: IotHubDescription
fullName: azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription
module: azure.mgmt.iothub.v2023_06_30_preview.models
inheritances:
- azure.mgmt.iothub.v2023_06_30_preview.models._models_py3.Resource
summary: 'The description of the IoT hub.


  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 Azure.'
constructor:
  syntax: 'IotHubDescription(*, location: str, sku: _models.IotHubSkuInfo, tags: Dict[str,
    str] | None = None, etag: str | None = None, properties: _models.IotHubProperties
    | None = None, identity: _models.ArmIdentity | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: location
    description: The resource location. Required.
    types:
    - <xref:str>
  - name: tags
    description: The resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: etag
    description: '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.'
    types:
    - <xref:str>
  - name: properties
    description: IotHub properties.
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubProperties>
  - name: sku
    description: IotHub SKU info. Required.
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubSkuInfo>
  - name: identity
    description: The managed identities for the IotHub.
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.ArmIdentity>
variables:
- description: The resource identifier.
  name: id
  types:
  - <xref:str>
- description: The resource name.
  name: name
  types:
  - <xref:str>
- description: The resource type.
  name: type
  types:
  - <xref:str>
- description: The resource location. Required.
  name: location
  types:
  - <xref:str>
- description: The resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: '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.'
  name: etag
  types:
  - <xref:str>
- description: IotHub properties.
  name: properties
  types:
  - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubProperties>
- description: IotHub SKU info. Required.
  name: sku
  types:
  - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubSkuInfo>
- description: The managed identities for the IotHub.
  name: identity
  types:
  - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.ArmIdentity>
- description: The system meta data relating to this resource.
  name: system_data
  types:
  - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.SystemData>