Skip to content

Split Az.DigitalTwins Examples #17097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/DigitalTwins/help/Get-AzDigitalTwinsEndpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Get DigitalTwinsInstances Endpoint.

### Example 1: List AzDigitalTwinsEndpoint in ResourceGroup
```powershell
PS C:\> Get-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
Get-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
```

```output
Name Type
---- ----
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
Expand All @@ -48,8 +50,10 @@ List all AzDigitalTwinsEndpoints by ResourceGroupName

### Example 2: Get AzDigitalTwinsEndpoint by EndpointName
```powershell
PS C:\> Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
```

```output
Name Type
---- ----
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
Expand All @@ -59,9 +63,11 @@ Get AzDigitalTwinsEndpoint by EndpointName in ResourceGroup

### Example 3: Get AzDigitalTwinsEndpoint by 'AzDigitalTwinsEndpoint' Object
```powershell
PS C:\> $GetAzDigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
$GetAzDigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
Get-AzDigitalTwinsEndpoint -InputObject $GetAzDigitalTwinsEndpoint
```

```output
Name Type
---- ----
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
Expand Down
16 changes: 12 additions & 4 deletions src/DigitalTwins/help/Get-AzDigitalTwinsInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ Get DigitalTwinsInstances resource.

### Example 1: List (Default)
```powershell
PS C:\> Get-AzDigitalTwinsInstance
Get-AzDigitalTwinsInstance
```

```output
Location Name Type
-------- ---- ----
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances
Expand All @@ -54,8 +56,10 @@ Get all the DigitalTwinsInstance by default

### Example 2: Get
```powershell
PS C:\> Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
```

```output
Location Name Type
-------- ---- ----
eastus youriDigitalTwin Microsoft.DigitalTwins/digitalTwinsInstances
Expand All @@ -65,9 +69,11 @@ Get the specified AzDigitalTwinsInstance by ResourceName

### Example 3: GetViaIdentity
```powershell
PS C:\> $NewAzDigital = New-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin -Location eastus
$NewAzDigital = New-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin -Location eastus
Get-AzDigitalTwinsInstance -inputObject $NewAzDigital
```

```output
Location Name Type
-------- ---- ----
eastus youriDigitalTwin Microsoft.DigitalTwins/digitalTwinsInstances
Expand All @@ -77,8 +83,10 @@ Get the specified AzDigitalTwinsInstance by Object

### Example 4: List1
```powershell
PS C:\> Get-AzDigitalTwinsInstance -ResourceGroupName youritemp
Get-AzDigitalTwinsInstance -ResourceGroupName youritemp
```

```output
Location Name Type
-------- ---- ----
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ Create a in-memory object for CheckNameRequest

### Example 1: Create a DigitalTwinsCheckNameRequestObject by name
```powershell
PS C:\> New-AzDigitalTwinsCheckNameRequestObject -name youriTestName
New-AzDigitalTwinsCheckNameRequestObject -name youriTestName
```

```output
Name Type
---- ----
youriTestName Microsoft.DigitalTwins/digitalTwinsInstances
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ Create a in-memory object for DigitalTwinsIdentity

### Example 1: Create A DigitalTwinsIdentityObject
```powershell
PS C:\> New-AzDigitalTwinsDigitalTwinsIdentityObject -Id '************' -Location eastus
New-AzDigitalTwinsDigitalTwinsIdentityObject -Id '************' -Location eastus
```

```output
EndpointName Location ResourceGroupName ResourceName SubscriptionId
------------ -------- ----------------- ------------ --------------
eastus
Expand Down
12 changes: 9 additions & 3 deletions src/DigitalTwins/help/New-AzDigitalTwinsEndpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,10 @@ Create or update DigitalTwinsInstance endpoint.

### Example 1: Create an AzDigitalTwinsEndpoint for Eventhub
```powershell
PS C:\> New-AzDigitalTwinsEndpoint -EndpointName youriEventHubEndPoint -EndpointType EventHub -ResourceGroupName youritemp -ResourceName youriDigitalTwins -connectionStringPrimaryKey 'Endpoint=sb://yourieventhubnp.servicebus.windows.net/;SharedAccessKeyName=youriEventhubPolicy;SharedAccessKey=********;EntityPath=yourieventhub'
New-AzDigitalTwinsEndpoint -EndpointName youriEventHubEndPoint -EndpointType EventHub -ResourceGroupName youritemp -ResourceName youriDigitalTwins -connectionStringPrimaryKey 'Endpoint=sb://yourieventhubnp.servicebus.windows.net/;SharedAccessKeyName=youriEventhubPolicy;SharedAccessKey=********;EntityPath=yourieventhub'
```

```output
Name Type
---- ----
youriEventHubEndPoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
Expand All @@ -55,8 +57,10 @@ Create an AzDigitalTwinsEndpoint for Eventhub by connectionStringPrimaryKey

### Example 2: Create an AzDigitalTwinsEndpoint for EventGrid
```powershell
PS C:\> New-AzDigitalTwinsEndpoint -EndpointName youriEventGridPoint -EndpointType EventGrid -ResourceGroupName youritemp -ResourceName youriDigitalTwins -TopicEndpoint 'https://yourieventgrid.eastus-1.eventgrid.azure.net/api/events' -AccessKey1 'xxxxxxxxx='
New-AzDigitalTwinsEndpoint -EndpointName youriEventGridPoint -EndpointType EventGrid -ResourceGroupName youritemp -ResourceName youriDigitalTwins -TopicEndpoint 'https://yourieventgrid.eastus-1.eventgrid.azure.net/api/events' -AccessKey1 'xxxxxxxxx='
```

```output
Name Type
---- ----
youriEventGridPoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
Expand All @@ -66,8 +70,10 @@ Create an AzDigitalTwinsEndpoint for Eventhub by TopicEndpoint and accessKey1

### Example 3: Create an AzDigitalTwinsEndpoint for ServiceBus
```powershell
PS C:\> New-AzDigitalTwinsEndpoint -EndpointName youriServiceBusPoint -EndpointType ServiceBus -ResourceGroupName youritemp -ResourceName youriDigitalTwins -PrimaryConnectionString "Endpoint=sb://yourieventhubnp.servicebus.windows.net/;SharedAccessKeyName=******;SharedAccessKey=********;EntityPath=yourieventhub"
New-AzDigitalTwinsEndpoint -EndpointName youriServiceBusPoint -EndpointType ServiceBus -ResourceGroupName youritemp -ResourceName youriDigitalTwins -PrimaryConnectionString "Endpoint=sb://yourieventhubnp.servicebus.windows.net/;SharedAccessKeyName=******;SharedAccessKey=********;EntityPath=yourieventhub"
```

```output
Name Type
---- ----
youriServiceBusPoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
Expand Down
8 changes: 6 additions & 2 deletions src/DigitalTwins/help/New-AzDigitalTwinsInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@ The usual pattern to modify a property is to retrieve the DigitalTwinsInstance a

### Example 1: Create an AzDigitalTwinsInstance by default.
```powershell
PS C:\> New-AzDigitalTwinsInstance -ResourceGroupName youritest -ResourceName youriDigitalTwin -Location eastus
New-AzDigitalTwinsInstance -ResourceGroupName youritest -ResourceName youriDigitalTwin -Location eastus
```

```output
Location Name SkuName Type
-------- ---- ------- ----
eastus youriDigitalTwin S1 Microsoft.DigitalTwins/digitalTwinsInstances
Expand All @@ -46,9 +48,11 @@ Create an AzDigitalTwinsInstance by default

### Example 2: Create an AzDigitalTwinsInstance by AzDigitalTwins Object.
```powershell
PS C:\> $GetAzDigTwin = Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
$GetAzDigTwin = Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
New-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest01 -DigitalTwinsCreate $getAzdigitalTwins
```

```output
Location Name Type
-------- ---- ----
eastus youriDigitalTwinsTest01 Microsoft.DigitalTwins/digitalTwinsInstances
Expand Down
6 changes: 2 additions & 4 deletions src/DigitalTwins/help/Remove-AzDigitalTwinsEndpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,15 @@ Delete a DigitalTwinsInstance endpoint.

### Example 1: Delete the azDigitalTwinsEndPoint by EndPointName
```powershell
PS C:\> Remove-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -EndpointName youriEHEndpoint -ResourceName youriDigitalTwinsTest

Remove-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -EndpointName youriEHEndpoint -ResourceName youriDigitalTwinsTest
```

Delete the azDigitalTwinsEndPoint by EndPointName ResourceGroupName and ResourceName

### Example 2: Delete the azDigitalTwinsEndPoint by Object
```powershell
PS C:\> $GetAzdigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriEHEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
$GetAzdigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriEHEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
Remove-AzDigitalTwinsEndpoint -InputObject $GetAzdigitalTwinsEndpoint

```

Delete the azDigitalTwinsEndPoint by Object
Expand Down
8 changes: 2 additions & 6 deletions src/DigitalTwins/help/Remove-AzDigitalTwinsInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,15 @@ Delete a DigitalTwinsInstance.

### Example 1: Remove an AzDigitalTwinsInstance by name
```powershell
PS C:\> Remove-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin


Remove-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
```

This command removes an AzDigitalTwinsInstance by name

### Example 2: Remove an AzDigitalTwinsInstance by InputObject
```powershell
PS C:\> $GetAzDigitalTwins = Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
$GetAzDigitalTwins = Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
Remove-AzDigitalTwinsInstance -InputObject $GetAzDigitalTwins


```

This command removes an AzDigitalTwinsInstance by name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,10 @@ Check if a DigitalTwinsInstance name is available.

### Example 1: Check the name by location and name.
```powershell
PS C:\> Test-AzDigitalTwinsInstanceNameAvailability -Location eastus -name youriTestName
Test-AzDigitalTwinsInstanceNameAvailability -Location eastus -name youriTestName
```

```output
Message NameAvailable Reason
------- ------------- ------
'youriTestName' is available. True
Expand All @@ -56,10 +58,12 @@ Check the availability of the name by location and name.

### Example 2: Check the name by DigitalTwinsObject and CheckNameObject.
```powershell
PS C:\> $getAzDT =Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
$getAzDT =Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
$checkName = New-AzDigitalTwinsCheckNameRequestObject -name youriTestName
Test-AzDigitalTwinsInstanceNameAvailability -InputObject $getAzDT -DigitalTwinsInstanceCheckName $checkName
```

```output
Message NameAvailable Reason
------- ------------- ------
'youriTestName' is available. True
Expand Down
8 changes: 6 additions & 2 deletions src/DigitalTwins/help/Update-AzDigitalTwinsInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,10 @@ Update metadata of DigitalTwinsInstance.

### Example 1: UpdateExpanded (Default)
```powershell
PS C:\> Update-AzDigitalTwinsInstance -ResourcegroupName youritemp -ResourceName youriDigitalTwinsTest -Tag @{“dtt”="001"}
Update-AzDigitalTwinsInstance -ResourcegroupName youritemp -ResourceName youriDigitalTwinsTest -Tag @{“dtt”="001"}
```

```output
Location Name Type
-------- ---- ----
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances
Expand All @@ -56,9 +58,11 @@ Update the specified DigitalTwinsInstance by ResourceGroupName

### Example 2: Update the AzDigitalTwinsInstance by another AzDigitalTwinsInstance
```powershell
PS C:\> $updateDigitalTwinInstance1 = Update-AzDigitalTwinsInstance -ResourcegroupName youritemp -ResourceName youriDigitalTwin1 -Tag @{"dtt"="002"}
$updateDigitalTwinInstance1 = Update-AzDigitalTwinsInstance -ResourcegroupName youritemp -ResourceName youriDigitalTwin1 -Tag @{"dtt"="002"}
Update-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest -DigitalTwinsPatchDescription $updateDigitalTwinInstance1
```

```output
Location Name Type
-------- ---- ----
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances
Expand Down