Package com.azure.resourcemanager.digitaltwins.models

Class DigitalTwinsEndpointResourceProperties

  • Direct Known Subclasses:
    EventGrid, EventHub, ServiceBus
    public class DigitalTwinsEndpointResourceProperties
extends Object
    Properties related to Digital Twins Endpoint.

    • Constructor Detail

      • DigitalTwinsEndpointResourceProperties

        public DigitalTwinsEndpointResourceProperties()

    • Method Detail

      • provisioningState

        public EndpointProvisioningState provisioningState()
        Get the provisioningState property: The provisioning state.
        Returns:
        the provisioningState value.

      • createdTime

        public OffsetDateTime createdTime()
        Get the createdTime property: Time when the Endpoint was added to DigitalTwinsInstance.
        Returns:
        the createdTime value.

      • authenticationType

        public AuthenticationType authenticationType()
        Get 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.
        Returns:
        the authenticationType value.

      • withAuthenticationType

        public DigitalTwinsEndpointResourceProperties 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.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the DigitalTwinsEndpointResourceProperties object itself.

      • deadLetterSecret

        public String deadLetterSecret()
        Get the deadLetterSecret property: Dead letter storage secret for key-based authentication. Will be obfuscated during read.
        Returns:
        the deadLetterSecret value.

      • withDeadLetterSecret

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

      • deadLetterUri

        public String deadLetterUri()
        Get the deadLetterUri property: Dead letter storage URL for identity-based authentication.
        Returns:
        the deadLetterUri value.

      • withDeadLetterUri

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

      • validate

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