Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. digitaltwins
  5. getDigitalTwinsEndpoint
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.digitaltwins.getDigitalTwinsEndpoint

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Get DigitalTwinsInstances Endpoint. API Version: 2020-12-01.

    Using getDigitalTwinsEndpoint

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDigitalTwinsEndpoint(args: GetDigitalTwinsEndpointArgs, opts?: InvokeOptions): Promise<GetDigitalTwinsEndpointResult>
function getDigitalTwinsEndpointOutput(args: GetDigitalTwinsEndpointOutputArgs, opts?: InvokeOptions): Output<GetDigitalTwinsEndpointResult>
    def get_digital_twins_endpoint(endpoint_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               resource_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetDigitalTwinsEndpointResult
def get_digital_twins_endpoint_output(endpoint_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               resource_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetDigitalTwinsEndpointResult]
    func LookupDigitalTwinsEndpoint(ctx *Context, args *LookupDigitalTwinsEndpointArgs, opts ...InvokeOption) (*LookupDigitalTwinsEndpointResult, error)
func LookupDigitalTwinsEndpointOutput(ctx *Context, args *LookupDigitalTwinsEndpointOutputArgs, opts ...InvokeOption) LookupDigitalTwinsEndpointResultOutput

    > Note: This function is named LookupDigitalTwinsEndpoint in the Go SDK.

    public static class GetDigitalTwinsEndpoint 
{
    public static Task<GetDigitalTwinsEndpointResult> InvokeAsync(GetDigitalTwinsEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetDigitalTwinsEndpointResult> Invoke(GetDigitalTwinsEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDigitalTwinsEndpointResult> getDigitalTwinsEndpoint(GetDigitalTwinsEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:digitaltwins:getDigitalTwinsEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EndpointName string
    Name of Endpoint Resource.
    ResourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    ResourceName string
    The name of the DigitalTwinsInstance.
    EndpointName string
    Name of Endpoint Resource.
    ResourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    ResourceName string
    The name of the DigitalTwinsInstance.
    endpointName String
    Name of Endpoint Resource.
    resourceGroupName String
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName String
    The name of the DigitalTwinsInstance.
    endpointName string
    Name of Endpoint Resource.
    resourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName string
    The name of the DigitalTwinsInstance.
    endpoint_name str
    Name of Endpoint Resource.
    resource_group_name str
    The name of the resource group that contains the DigitalTwinsInstance.
    resource_name str
    The name of the DigitalTwinsInstance.
    endpointName String
    Name of Endpoint Resource.
    resourceGroupName String
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName String
    The name of the DigitalTwinsInstance.

    getDigitalTwinsEndpoint Result

    The following output properties are available:

    Id string
    The resource identifier.
    Name string
    Extension resource name.
    Properties Pulumi.AzureNative.DigitalTwins.Outputs.EventGridResponse | Pulumi.AzureNative.DigitalTwins.Outputs.EventHubResponse | Pulumi.AzureNative.DigitalTwins.Outputs.ServiceBusResponse
    DigitalTwinsInstance endpoint resource properties.
    Type string
    The resource type.
    Id string
    The resource identifier.
    Name string
    Extension resource name.
    Properties EventGridResponse | EventHubResponse | ServiceBusResponse
    DigitalTwinsInstance endpoint resource properties.
    Type string
    The resource type.
    id String
    The resource identifier.
    name String
    Extension resource name.
    properties EventGridResponse | EventHubResponse | ServiceBusResponse
    DigitalTwinsInstance endpoint resource properties.
    type String
    The resource type.
    id string
    The resource identifier.
    name string
    Extension resource name.
    properties EventGridResponse | EventHubResponse | ServiceBusResponse
    DigitalTwinsInstance endpoint resource properties.
    type string
    The resource type.
    id str
    The resource identifier.
    name str
    Extension resource name.
    properties EventGridResponse | EventHubResponse | ServiceBusResponse
    DigitalTwinsInstance endpoint resource properties.
    type str
    The resource type.
    id String
    The resource identifier.
    name String
    Extension resource name.
    properties Property Map | Property Map | Property Map
    DigitalTwinsInstance endpoint resource properties.
    type String
    The resource type.

    Supporting Types

    EventGridResponse

    AccessKey1 string
    EventGrid secondary accesskey. Will be obfuscated during read.
    CreatedTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    ProvisioningState string
    The provisioning state.
    TopicEndpoint string
    EventGrid Topic Endpoint
    AccessKey2 string
    EventGrid secondary accesskey. Will be obfuscated during read.
    AuthenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    DeadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    DeadLetterUri string
    Dead letter storage URL for identity-based authentication.
    AccessKey1 string
    EventGrid secondary accesskey. Will be obfuscated during read.
    CreatedTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    ProvisioningState string
    The provisioning state.
    TopicEndpoint string
    EventGrid Topic Endpoint
    AccessKey2 string
    EventGrid secondary accesskey. Will be obfuscated during read.
    AuthenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    DeadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    DeadLetterUri string
    Dead letter storage URL for identity-based authentication.
    accessKey1 String
    EventGrid secondary accesskey. Will be obfuscated during read.
    createdTime String
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState String
    The provisioning state.
    topicEndpoint String
    EventGrid Topic Endpoint
    accessKey2 String
    EventGrid secondary accesskey. Will be obfuscated during read.
    authenticationType String
    Specifies the authentication type being used for connecting to the endpoint.
    deadLetterSecret String
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri String
    Dead letter storage URL for identity-based authentication.
    accessKey1 string
    EventGrid secondary accesskey. Will be obfuscated during read.
    createdTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState string
    The provisioning state.
    topicEndpoint string
    EventGrid Topic Endpoint
    accessKey2 string
    EventGrid secondary accesskey. Will be obfuscated during read.
    authenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    deadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri string
    Dead letter storage URL for identity-based authentication.
    access_key1 str
    EventGrid secondary accesskey. Will be obfuscated during read.
    created_time str
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioning_state str
    The provisioning state.
    topic_endpoint str
    EventGrid Topic Endpoint
    access_key2 str
    EventGrid secondary accesskey. Will be obfuscated during read.
    authentication_type str
    Specifies the authentication type being used for connecting to the endpoint.
    dead_letter_secret str
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    dead_letter_uri str
    Dead letter storage URL for identity-based authentication.
    accessKey1 String
    EventGrid secondary accesskey. Will be obfuscated during read.
    createdTime String
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState String
    The provisioning state.
    topicEndpoint String
    EventGrid Topic Endpoint
    accessKey2 String
    EventGrid secondary accesskey. Will be obfuscated during read.
    authenticationType String
    Specifies the authentication type being used for connecting to the endpoint.
    deadLetterSecret String
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri String
    Dead letter storage URL for identity-based authentication.

    EventHubResponse

    CreatedTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    ProvisioningState string
    The provisioning state.
    AuthenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    ConnectionStringPrimaryKey string
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    ConnectionStringSecondaryKey string
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    DeadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    DeadLetterUri string
    Dead letter storage URL for identity-based authentication.
    EndpointUri string
    The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
    EntityPath string
    The EventHub name in the EventHub namespace for identity-based authentication.
    CreatedTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    ProvisioningState string
    The provisioning state.
    AuthenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    ConnectionStringPrimaryKey string
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    ConnectionStringSecondaryKey string
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    DeadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    DeadLetterUri string
    Dead letter storage URL for identity-based authentication.
    EndpointUri string
    The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
    EntityPath string
    The EventHub name in the EventHub namespace for identity-based authentication.
    createdTime String
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState String
    The provisioning state.
    authenticationType String
    Specifies the authentication type being used for connecting to the endpoint.
    connectionStringPrimaryKey String
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    connectionStringSecondaryKey String
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    deadLetterSecret String
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri String
    Dead letter storage URL for identity-based authentication.
    endpointUri String
    The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
    entityPath String
    The EventHub name in the EventHub namespace for identity-based authentication.
    createdTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState string
    The provisioning state.
    authenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    connectionStringPrimaryKey string
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    connectionStringSecondaryKey string
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    deadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri string
    Dead letter storage URL for identity-based authentication.
    endpointUri string
    The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
    entityPath string
    The EventHub name in the EventHub namespace for identity-based authentication.
    created_time str
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioning_state str
    The provisioning state.
    authentication_type str
    Specifies the authentication type being used for connecting to the endpoint.
    connection_string_primary_key str
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    connection_string_secondary_key str
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    dead_letter_secret str
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    dead_letter_uri str
    Dead letter storage URL for identity-based authentication.
    endpoint_uri str
    The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
    entity_path str
    The EventHub name in the EventHub namespace for identity-based authentication.
    createdTime String
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState String
    The provisioning state.
    authenticationType String
    Specifies the authentication type being used for connecting to the endpoint.
    connectionStringPrimaryKey String
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    connectionStringSecondaryKey String
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    deadLetterSecret String
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri String
    Dead letter storage URL for identity-based authentication.
    endpointUri String
    The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
    entityPath String
    The EventHub name in the EventHub namespace for identity-based authentication.

    ServiceBusResponse

    CreatedTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    ProvisioningState string
    The provisioning state.
    AuthenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    DeadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    DeadLetterUri string
    Dead letter storage URL for identity-based authentication.
    EndpointUri string
    The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb://
    EntityPath string
    The ServiceBus Topic name for identity-based authentication
    PrimaryConnectionString string
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    SecondaryConnectionString string
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    CreatedTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    ProvisioningState string
    The provisioning state.
    AuthenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    DeadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    DeadLetterUri string
    Dead letter storage URL for identity-based authentication.
    EndpointUri string
    The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb://
    EntityPath string
    The ServiceBus Topic name for identity-based authentication
    PrimaryConnectionString string
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    SecondaryConnectionString string
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    createdTime String
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState String
    The provisioning state.
    authenticationType String
    Specifies the authentication type being used for connecting to the endpoint.
    deadLetterSecret String
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri String
    Dead letter storage URL for identity-based authentication.
    endpointUri String
    The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb://
    entityPath String
    The ServiceBus Topic name for identity-based authentication
    primaryConnectionString String
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    secondaryConnectionString String
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    createdTime string
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState string
    The provisioning state.
    authenticationType string
    Specifies the authentication type being used for connecting to the endpoint.
    deadLetterSecret string
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri string
    Dead letter storage URL for identity-based authentication.
    endpointUri string
    The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb://
    entityPath string
    The ServiceBus Topic name for identity-based authentication
    primaryConnectionString string
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    secondaryConnectionString string
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    created_time str
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioning_state str
    The provisioning state.
    authentication_type str
    Specifies the authentication type being used for connecting to the endpoint.
    dead_letter_secret str
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    dead_letter_uri str
    Dead letter storage URL for identity-based authentication.
    endpoint_uri str
    The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb://
    entity_path str
    The ServiceBus Topic name for identity-based authentication
    primary_connection_string str
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    secondary_connection_string str
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    createdTime String
    Time when the Endpoint was added to DigitalTwinsInstance.
    provisioningState String
    The provisioning state.
    authenticationType String
    Specifies the authentication type being used for connecting to the endpoint.
    deadLetterSecret String
    Dead letter storage secret for key-based authentication. Will be obfuscated during read.
    deadLetterUri String
    Dead letter storage URL for identity-based authentication.
    endpointUri String
    The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol sb://
    entityPath String
    The ServiceBus Topic name for identity-based authentication
    primaryConnectionString String
    PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
    secondaryConnectionString String
    SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native