azure.mgmt.iothub.v2021_03_31.models.RoutingServiceBusQueueEndpointProperties.yml

### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2021_03_31.models.RoutingServiceBusQueueEndpointProperties
name: RoutingServiceBusQueueEndpointProperties
fullName: azure.mgmt.iothub.v2021_03_31.models.RoutingServiceBusQueueEndpointProperties
module: azure.mgmt.iothub.v2021_03_31.models
inheritances:
- azure.mgmt.iothub._serialization.Model
summary: 'The properties related to service bus queue endpoint types.


  All required parameters must be populated in order to send to Azure.'
constructor:
  syntax: 'RoutingServiceBusQueueEndpointProperties(*, name: str, id: str | None =
    None, connection_string: str | None = None, endpoint_uri: str | None = None, entity_path:
    str | None = None, authentication_type: str | _models.AuthenticationType | None
    = None, identity: _models.ManagedIdentity | None = None, subscription_id: str
    | None = None, resource_group: str | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: id
    description: Id of the service bus queue endpoint.
    types:
    - <xref:str>
  - name: connection_string
    description: The connection string of the service bus queue endpoint.
    types:
    - <xref:str>
  - name: endpoint_uri
    description: 'The url of the service bus queue endpoint. It must include the protocol

      sb://.'
    types:
    - <xref:str>
  - name: entity_path
    description: Queue name on the service bus namespace.
    types:
    - <xref:str>
  - name: authentication_type
    description: 'Method used to authenticate against the service bus queue

      endpoint. Known values are: "keyBased" and "identityBased".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.iothub.v2021_03_31.models.AuthenticationType>
  - name: identity
    description: Managed identity properties of routing service bus queue endpoint.
    types:
    - <xref:azure.mgmt.iothub.v2021_03_31.models.ManagedIdentity>
  - name: name
    description: 'The name that identifies this endpoint. The name can only include
      alphanumeric

      characters, periods, underscores, hyphens and has a maximum length of 64 characters.
      The

      following names are reserved:  events, fileNotifications, $default. Endpoint
      names must be

      unique across endpoint types. The name need not be the same as the actual queue
      name. Required.'
    types:
    - <xref:str>
  - name: subscription_id
    description: The subscription identifier of the service bus queue endpoint.
    types:
    - <xref:str>
  - name: resource_group
    description: The name of the resource group of the service bus queue endpoint.
    types:
    - <xref:str>
variables:
- description: Id of the service bus queue endpoint.
  name: id
  types:
  - <xref:str>
- description: The connection string of the service bus queue endpoint.
  name: connection_string
  types:
  - <xref:str>
- description: 'The url of the service bus queue endpoint. It must include the protocol

    sb://.'
  name: endpoint_uri
  types:
  - <xref:str>
- description: Queue name on the service bus namespace.
  name: entity_path
  types:
  - <xref:str>
- description: 'Method used to authenticate against the service bus queue endpoint.

    Known values are: "keyBased" and "identityBased".'
  name: authentication_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.iothub.v2021_03_31.models.AuthenticationType>
- description: Managed identity properties of routing service bus queue endpoint.
  name: identity
  types:
  - <xref:azure.mgmt.iothub.v2021_03_31.models.ManagedIdentity>
- description: 'The name that identifies this endpoint. The name can only include
    alphanumeric

    characters, periods, underscores, hyphens and has a maximum length of 64 characters.
    The

    following names are reserved:  events, fileNotifications, $default. Endpoint names
    must be

    unique across endpoint types. The name need not be the same as the actual queue
    name. Required.'
  name: name
  types:
  - <xref:str>
- description: The subscription identifier of the service bus queue endpoint.
  name: subscription_id
  types:
  - <xref:str>
- description: The name of the resource group of the service bus queue endpoint.
  name: resource_group
  types:
  - <xref:str>