public final class ServiceBus extends DigitalTwinsEndpointResourceProperties
Properties related to ServiceBus.
  • Constructor Details

    • ServiceBus

      public ServiceBus()
  • Method Details

    • primaryConnectionString

      public String primaryConnectionString()
      Get the primaryConnectionString property: PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
      Returns:
      the primaryConnectionString value.
    • withPrimaryConnectionString

      public ServiceBus withPrimaryConnectionString(String primaryConnectionString)
      Set the primaryConnectionString property: PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
      Parameters:
      primaryConnectionString - the primaryConnectionString value to set.
      Returns:
      the ServiceBus object itself.
    • secondaryConnectionString

      public String secondaryConnectionString()
      Get the secondaryConnectionString property: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
      Returns:
      the secondaryConnectionString value.
    • withSecondaryConnectionString

      public ServiceBus withSecondaryConnectionString(String secondaryConnectionString)
      Set the secondaryConnectionString property: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
      Parameters:
      secondaryConnectionString - the secondaryConnectionString value to set.
      Returns:
      the ServiceBus object itself.
    • endpointUri

      public String endpointUri()
      Get the endpointUri property: The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
      Returns:
      the endpointUri value.
    • withEndpointUri

      public ServiceBus withEndpointUri(String endpointUri)
      Set the endpointUri property: The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'.
      Parameters:
      endpointUri - the endpointUri value to set.
      Returns:
      the ServiceBus object itself.
    • entityPath

      public String entityPath()
      Get the entityPath property: The ServiceBus Topic name for identity-based authentication.
      Returns:
      the entityPath value.
    • withEntityPath

      public ServiceBus withEntityPath(String entityPath)
      Set the entityPath property: The ServiceBus Topic name for identity-based authentication.
      Parameters:
      entityPath - the entityPath value to set.
      Returns:
      the ServiceBus object itself.
    • withAuthenticationType

      public ServiceBus withAuthenticationType(AuthenticationType authenticationType)
      Set the authenticationType property: Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
      Overrides:
      withAuthenticationType in class DigitalTwinsEndpointResourceProperties
      Parameters:
      authenticationType - the authenticationType value to set.
      Returns:
      the DigitalTwinsEndpointResourceProperties object itself.
    • withDeadLetterSecret

      public ServiceBus withDeadLetterSecret(String deadLetterSecret)
      Set the deadLetterSecret property: Dead letter storage secret for key-based authentication. Will be obfuscated during read.
      Overrides:
      withDeadLetterSecret in class DigitalTwinsEndpointResourceProperties
      Parameters:
      deadLetterSecret - the deadLetterSecret value to set.
      Returns:
      the DigitalTwinsEndpointResourceProperties object itself.
    • withDeadLetterUri

      public ServiceBus withDeadLetterUri(String deadLetterUri)
      Set the deadLetterUri property: Dead letter storage URL for identity-based authentication.
      Overrides:
      withDeadLetterUri in class DigitalTwinsEndpointResourceProperties
      Parameters:
      deadLetterUri - the deadLetterUri value to set.
      Returns:
      the DigitalTwinsEndpointResourceProperties object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class DigitalTwinsEndpointResourceProperties
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.