Edit

Share via

New-AzDigitalTwinsPrivateEndpointConnection

  • Reference
Module:
Az.DigitalTwins

Update the status of a private endpoint connection with the given name.

Syntax

PowerShell 
New-AzDigitalTwinsPrivateEndpointConnection
   -Name <String>
   -ResourceGroupName <String>
   -ResourceName <String>
   [-SubscriptionId <String>]
   [-GroupId <String[]>]
   [-PrivateLinkServiceConnectionStateActionsRequired <String>]
   [-PrivateLinkServiceConnectionStateDescription <String>]
   [-PrivateLinkServiceConnectionStateStatus <PrivateLinkServiceConnectionStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
PowerShell 
New-AzDigitalTwinsPrivateEndpointConnection
   -InputObject <IDigitalTwinsIdentity>
   [-GroupId <String[]>]
   [-PrivateLinkServiceConnectionStateActionsRequired <String>]
   [-PrivateLinkServiceConnectionStateDescription <String>]
   [-PrivateLinkServiceConnectionStateStatus <PrivateLinkServiceConnectionStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Update the status of a private endpoint connection with the given name.

Examples

Example 1: Update the status of a private endpoint connection with the given name.

PowerShell 
New-AzDigitalTwinsPrivateEndpointConnection -Name "11c903a5-7b8a-4b86-812d-03f007dca6df" -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -PrivateLinkServiceConnectionStateStatus 'Approved' -PrivateLinkServiceConnectionStateDescription "Approved by johndoe@company.com."

Name                                 GroupId PrivateLinkServiceConnectionStateStatus ResourceGroupName
----                                 ------- --------------------------------------- -----------------
11c903a5-7b8a-4b86-812d-03f007dca6df {API}   Approved                                azps_test_group

Update the status of a private endpoint connection with the given name. Please Create a Private Endpoint in Azure Digital Twins -> Networking -> Private endpoint connections.

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

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

-GroupId

The list of group ids for the private endpoint connection.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the private endpoint connection.

Type:String
Aliases:PrivateEndpointConnectionName
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

-PrivateLinkServiceConnectionStateActionsRequired

Actions required for a private endpoint connection.

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

-PrivateLinkServiceConnectionStateDescription

The description for the current state of a private endpoint connection.

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

-PrivateLinkServiceConnectionStateStatus

The status of a private endpoint connection.

Type:PrivateLinkServiceConnectionStatus
Position:Named
Default value:None
Required:False
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

-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

Outputs