New-AzDigitalTwinsEndpoint

Module:

Az.DigitalTwins

Create or update DigitalTwinsInstance endpoint.

Syntax

PowerShell

New-AzDigitalTwinsEndpoint
   -EndpointName <String>
   -ResourceGroupName <String>
   -ResourceName <String>
   [-SubscriptionId <String>]
   -EndpointType <EndpointType>
   -ConnectionStringPrimaryKey <String>
   [-EndpointDescription <IDigitalTwinsEndpointResource>]
   [-AuthenticationType <AuthenticationType>]
   [-ConnectionStringSecondaryKey <String>]
   [-DeadLetterSecret <String>]
   [-DeadLetterUri <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

PowerShell

New-AzDigitalTwinsEndpoint
   -EndpointName <String>
   -ResourceGroupName <String>
   -ResourceName <String>
   [-SubscriptionId <String>]
   -EndpointType <EndpointType>
   [-EndpointDescription <IDigitalTwinsEndpointResource>]
   [-AuthenticationType <AuthenticationType>]
   [-DeadLetterSecret <String>]
   [-DeadLetterUri <String>]
   -PrimaryConnectionString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

PowerShell

New-AzDigitalTwinsEndpoint
   -EndpointName <String>
   -ResourceGroupName <String>
   -ResourceName <String>
   [-SubscriptionId <String>]
   -EndpointType <EndpointType>
   [-EndpointDescription <IDigitalTwinsEndpointResource>]
   [-AuthenticationType <AuthenticationType>]
   [-DeadLetterSecret <String>]
   [-DeadLetterUri <String>]
   -TopicEndpoint <String>
   -AccessKey1 <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create or update DigitalTwinsInstance endpoint.

Examples

Example 1: Create an AzDigitalTwinsEndpoint for Eventhub

PowerShell

New-AzDigitalTwinsEndpoint -EndpointName azps-dt-eh -EndpointType EventHub -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -connectionStringPrimaryKey 'Endpoint=sb://azps-eventhubs.servicebus.windows.net/;SharedAccessKeyName=abc123;SharedAccessKey=******;EntityPath=azps-eh' -AuthenticationType 'KeyBased'

Name       EndpointType AuthenticationType ResourceGroupName
----       ------------ ------------------ -----------------
azps-dt-eh EventHub     KeyBased           azps_test_group

Create an AzDigitalTwinsEndpoint for Eventhub by connectionStringPrimaryKey

Example 2: Create an AzDigitalTwinsEndpoint for EventGrid

PowerShell

New-AzDigitalTwinsEndpoint -EndpointName azps-dt-eg -EndpointType EventGrid -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -TopicEndpoint 'https://azps-eventgrid.eastus-1.eventgrid.azure.net/api/events' -AccessKey1 '******=' -AuthenticationType 'KeyBased'

Name       EndpointType AuthenticationType ResourceGroupName
----       ------------ ------------------ -----------------
azps-dt-eg EventGrid    KeyBased           azps_test_group

Create an AzDigitalTwinsEndpoint for Eventhub by TopicEndpoint and accessKey1

Example 3: Create an AzDigitalTwinsEndpoint for ServiceBus

PowerShell

New-AzDigitalTwinsEndpoint -EndpointName azps-dt-sb -EndpointType ServiceBus -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -PrimaryConnectionString "Endpoint=sb://azps-servicebus.servicebus.windows.net/;SharedAccessKeyName=abc123;SharedAccessKey=******;EntityPath=azps-sb" -AuthenticationType 'KeyBased'

Name       EndpointType AuthenticationType ResourceGroupName
----       ------------ ------------------ -----------------
azps-dt-sb ServiceBus   KeyBased           azps_test_group

Create an AzDigitalTwinsEndpoint for ServicBus by PrimaryConnectionString

Parameters

-AccessKey1

The subscription identifier.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AuthenticationType

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.

Type:	AuthenticationType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionStringPrimaryKey

The subscription identifier.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionStringSecondaryKey

The subscription identifier.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeadLetterSecret

Dead letter storage secret for key-based authentication. Will be obfuscated during read.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeadLetterUri

Dead letter storage URL for identity-based authentication.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EndpointDescription

DigitalTwinsInstance endpoint resource. To construct, see NOTES section for ENDPOINTDESCRIPTION properties and create a hash table.

Type:	IDigitalTwinsEndpointResource
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-EndpointName

Name of Endpoint Resource.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-EndpointType

The type of Digital Twins endpoint

Type:	EndpointType
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PrimaryConnectionString

The subscription identifier.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group that contains the DigitalTwinsInstance.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceName

The name of the DigitalTwinsInstance.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The subscription identifier.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TopicEndpoint

The subscription identifier.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IDigitalTwinsEndpointResource

Outputs

IDigitalTwinsEndpointResource