Skip to content

Commit aa46098

Browse files
Split Az.DigitalTwins Examples in generation (#17098)
1 parent c16c2ad commit aa46098

20 files changed

+116
-56
lines changed

src/DigitalTwins/docs/Get-AzDigitalTwinsEndpoint.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Get DigitalTwinsInstances Endpoint.
3737

3838
### Example 1: List AzDigitalTwinsEndpoint in ResourceGroup
3939
```powershell
40-
PS C:\> Get-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
40+
Get-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
41+
```
4142

43+
```output
4244
Name Type
4345
---- ----
4446
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
@@ -48,8 +50,10 @@ List all AzDigitalTwinsEndpoints by ResourceGroupName
4850

4951
### Example 2: Get AzDigitalTwinsEndpoint by EndpointName
5052
```powershell
51-
PS C:\> Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
53+
Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
54+
```
5255

56+
```output
5357
Name Type
5458
---- ----
5559
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
@@ -59,9 +63,11 @@ Get AzDigitalTwinsEndpoint by EndpointName in ResourceGroup
5963

6064
### Example 3: Get AzDigitalTwinsEndpoint by 'AzDigitalTwinsEndpoint' Object
6165
```powershell
62-
PS C:\> $GetAzDigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
66+
$GetAzDigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
6367
Get-AzDigitalTwinsEndpoint -InputObject $GetAzDigitalTwinsEndpoint
68+
```
6469

70+
```output
6571
Name Type
6672
---- ----
6773
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints

src/DigitalTwins/docs/Get-AzDigitalTwinsInstance.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,10 @@ Get DigitalTwinsInstances resource.
4242

4343
### Example 1: List (Default)
4444
```powershell
45-
PS C:\> Get-AzDigitalTwinsInstance
45+
Get-AzDigitalTwinsInstance
46+
```
4647

48+
```output
4749
Location Name Type
4850
-------- ---- ----
4951
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances
@@ -54,8 +56,10 @@ Get all the DigitalTwinsInstance by default
5456

5557
### Example 2: Get
5658
```powershell
57-
PS C:\> Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
59+
Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
60+
```
5861

62+
```output
5963
Location Name Type
6064
-------- ---- ----
6165
eastus youriDigitalTwin Microsoft.DigitalTwins/digitalTwinsInstances
@@ -65,9 +69,11 @@ Get the specified AzDigitalTwinsInstance by ResourceName
6569

6670
### Example 3: GetViaIdentity
6771
```powershell
68-
PS C:\> $NewAzDigital = New-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin -Location eastus
72+
$NewAzDigital = New-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin -Location eastus
6973
Get-AzDigitalTwinsInstance -inputObject $NewAzDigital
74+
```
7075

76+
```output
7177
Location Name Type
7278
-------- ---- ----
7379
eastus youriDigitalTwin Microsoft.DigitalTwins/digitalTwinsInstances
@@ -77,8 +83,10 @@ Get the specified AzDigitalTwinsInstance by Object
7783

7884
### Example 4: List1
7985
```powershell
80-
PS C:\> Get-AzDigitalTwinsInstance -ResourceGroupName youritemp
86+
Get-AzDigitalTwinsInstance -ResourceGroupName youritemp
87+
```
8188

89+
```output
8290
Location Name Type
8391
-------- ---- ----
8492
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances

src/DigitalTwins/docs/New-AzDigitalTwinsCheckNameRequestObject.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ Create a in-memory object for CheckNameRequest
2323

2424
### Example 1: Create a DigitalTwinsCheckNameRequestObject by name
2525
```powershell
26-
PS C:\> New-AzDigitalTwinsCheckNameRequestObject -name youriTestName
26+
New-AzDigitalTwinsCheckNameRequestObject -name youriTestName
27+
```
2728

29+
```output
2830
Name Type
2931
---- ----
3032
youriTestName Microsoft.DigitalTwins/digitalTwinsInstances

src/DigitalTwins/docs/New-AzDigitalTwinsDigitalTwinsIdentityObject.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ Create a in-memory object for DigitalTwinsIdentity
2424

2525
### Example 1: Create A DigitalTwinsIdentityObject
2626
```powershell
27-
PS C:\> New-AzDigitalTwinsDigitalTwinsIdentityObject -Id '************' -Location eastus
27+
New-AzDigitalTwinsDigitalTwinsIdentityObject -Id '************' -Location eastus
28+
```
2829

30+
```output
2931
EndpointName Location ResourceGroupName ResourceName SubscriptionId
3032
------------ -------- ----------------- ------------ --------------
3133
eastus

src/DigitalTwins/docs/New-AzDigitalTwinsEndpoint.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,10 @@ Create or update DigitalTwinsInstance endpoint.
4444

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

50+
```output
4951
Name Type
5052
---- ----
5153
youriEventHubEndPoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
@@ -55,8 +57,10 @@ Create an AzDigitalTwinsEndpoint for Eventhub by connectionStringPrimaryKey
5557

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

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

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

76+
```output
7177
Name Type
7278
---- ----
7379
youriServiceBusPoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints

src/DigitalTwins/docs/New-AzDigitalTwinsInstance.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@ The usual pattern to modify a property is to retrieve the DigitalTwinsInstance a
3535

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

41+
```output
4042
Location Name SkuName Type
4143
-------- ---- ------- ----
4244
eastus youriDigitalTwin S1 Microsoft.DigitalTwins/digitalTwinsInstances
@@ -46,9 +48,11 @@ Create an AzDigitalTwinsInstance by default
4648

4749
### Example 2: Create an AzDigitalTwinsInstance by AzDigitalTwins Object.
4850
```powershell
49-
PS C:\> $GetAzDigTwin = Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
51+
$GetAzDigTwin = Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
5052
New-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest01 -DigitalTwinsCreate $getAzdigitalTwins
53+
```
5154

55+
```output
5256
Location Name Type
5357
-------- ---- ----
5458
eastus youriDigitalTwinsTest01 Microsoft.DigitalTwins/digitalTwinsInstances

src/DigitalTwins/docs/Remove-AzDigitalTwinsEndpoint.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,15 @@ Delete a DigitalTwinsInstance endpoint.
3232

3333
### Example 1: Delete the azDigitalTwinsEndPoint by EndPointName
3434
```powershell
35-
PS C:\> Remove-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -EndpointName youriEHEndpoint -ResourceName youriDigitalTwinsTest
36-
35+
Remove-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -EndpointName youriEHEndpoint -ResourceName youriDigitalTwinsTest
3736
```
3837

3938
Delete the azDigitalTwinsEndPoint by EndPointName ResourceGroupName and ResourceName
4039

4140
### Example 2: Delete the azDigitalTwinsEndPoint by Object
4241
```powershell
43-
PS C:\> $GetAzdigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriEHEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
42+
$GetAzdigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriEHEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
4443
Remove-AzDigitalTwinsEndpoint -InputObject $GetAzdigitalTwinsEndpoint
45-
4644
```
4745

4846
Delete the azDigitalTwinsEndPoint by Object

src/DigitalTwins/docs/Remove-AzDigitalTwinsInstance.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,15 @@ Delete a DigitalTwinsInstance.
3131

3232
### Example 1: Remove an AzDigitalTwinsInstance by name
3333
```powershell
34-
PS C:\> Remove-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
35-
36-
34+
Remove-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
3735
```
3836

3937
This command removes an AzDigitalTwinsInstance by name
4038

4139
### Example 2: Remove an AzDigitalTwinsInstance by InputObject
4240
```powershell
43-
PS C:\> $GetAzDigitalTwins = Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
41+
$GetAzDigitalTwins = Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
4442
Remove-AzDigitalTwinsInstance -InputObject $GetAzDigitalTwins
45-
46-
4743
```
4844

4945
This command removes an AzDigitalTwinsInstance by name

src/DigitalTwins/docs/Test-AzDigitalTwinsInstanceNameAvailability.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,10 @@ Check if a DigitalTwinsInstance name is available.
4545

4646
### Example 1: Check the name by location and name.
4747
```powershell
48-
PS C:\> Test-AzDigitalTwinsInstanceNameAvailability -Location eastus -name youriTestName
48+
Test-AzDigitalTwinsInstanceNameAvailability -Location eastus -name youriTestName
49+
```
4950

51+
```output
5052
Message NameAvailable Reason
5153
------- ------------- ------
5254
'youriTestName' is available. True
@@ -56,10 +58,12 @@ Check the availability of the name by location and name.
5658

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

66+
```output
6367
Message NameAvailable Reason
6468
------- ------------- ------
6569
'youriTestName' is available. True

src/DigitalTwins/docs/Update-AzDigitalTwinsInstance.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,10 @@ Update metadata of DigitalTwinsInstance.
4545

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

51+
```output
5052
Location Name Type
5153
-------- ---- ----
5254
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances
@@ -56,9 +58,11 @@ Update the specified DigitalTwinsInstance by ResourceGroupName
5658

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

65+
```output
6266
Location Name Type
6367
-------- ---- ----
6468
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances

src/DigitalTwins/examples/Get-AzDigitalTwinsEndpoint.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: List AzDigitalTwinsEndpoint in ResourceGroup
22
```powershell
3-
PS C:\> Get-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
3+
Get-AzDigitalTwinsEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
4+
```
45

6+
```output
57
Name Type
68
---- ----
79
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
@@ -11,8 +13,10 @@ List all AzDigitalTwinsEndpoints by ResourceGroupName
1113

1214
### Example 2: Get AzDigitalTwinsEndpoint by EndpointName
1315
```powershell
14-
PS C:\> Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
16+
Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
17+
```
1518

19+
```output
1620
Name Type
1721
---- ----
1822
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints
@@ -22,9 +26,11 @@ Get AzDigitalTwinsEndpoint by EndpointName in ResourceGroup
2226

2327
### Example 3: Get AzDigitalTwinsEndpoint by 'AzDigitalTwinsEndpoint' Object
2428
```powershell
25-
PS C:\> $GetAzDigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
29+
$GetAzDigitalTwinsEndpoint = Get-AzDigitalTwinsEndpoint -EndpointName youriDigitalTwinEndpoint -ResourceGroupName youritemp -ResourceName youriDigitalTwinsTest
2630
Get-AzDigitalTwinsEndpoint -InputObject $GetAzDigitalTwinsEndpoint
31+
```
2732

33+
```output
2834
Name Type
2935
---- ----
3036
youriDigitalTwinEndpoint Microsoft.DigitalTwins/digitalTwinsInstances/endpoints

src/DigitalTwins/examples/Get-AzDigitalTwinsInstance.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: List (Default)
22
```powershell
3-
PS C:\> Get-AzDigitalTwinsInstance
3+
Get-AzDigitalTwinsInstance
4+
```
45

6+
```output
57
Location Name Type
68
-------- ---- ----
79
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances
@@ -12,8 +14,10 @@ Get all the DigitalTwinsInstance by default
1214

1315
### Example 2: Get
1416
```powershell
15-
PS C:\> Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
17+
Get-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin
18+
```
1619

20+
```output
1721
Location Name Type
1822
-------- ---- ----
1923
eastus youriDigitalTwin Microsoft.DigitalTwins/digitalTwinsInstances
@@ -23,9 +27,11 @@ Get the specified AzDigitalTwinsInstance by ResourceName
2327

2428
### Example 3: GetViaIdentity
2529
```powershell
26-
PS C:\> $NewAzDigital = New-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin -Location eastus
30+
$NewAzDigital = New-AzDigitalTwinsInstance -ResourceGroupName youritemp -ResourceName youriDigitalTwin -Location eastus
2731
Get-AzDigitalTwinsInstance -inputObject $NewAzDigital
32+
```
2833

34+
```output
2935
Location Name Type
3036
-------- ---- ----
3137
eastus youriDigitalTwin Microsoft.DigitalTwins/digitalTwinsInstances
@@ -35,8 +41,10 @@ Get the specified AzDigitalTwinsInstance by Object
3541

3642
### Example 4: List1
3743
```powershell
38-
PS C:\> Get-AzDigitalTwinsInstance -ResourceGroupName youritemp
44+
Get-AzDigitalTwinsInstance -ResourceGroupName youritemp
45+
```
3946

47+
```output
4048
Location Name Type
4149
-------- ---- ----
4250
eastus youriDigitalTwinsTest Microsoft.DigitalTwins/digitalTwinsInstances

src/DigitalTwins/examples/New-AzDigitalTwinsCheckNameRequestObject.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: Create a DigitalTwinsCheckNameRequestObject by name
22
```powershell
3-
PS C:\> New-AzDigitalTwinsCheckNameRequestObject -name youriTestName
3+
New-AzDigitalTwinsCheckNameRequestObject -name youriTestName
4+
```
45

6+
```output
57
Name Type
68
---- ----
79
youriTestName Microsoft.DigitalTwins/digitalTwinsInstances

src/DigitalTwins/examples/New-AzDigitalTwinsDigitalTwinsIdentityObject.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: Create A DigitalTwinsIdentityObject
22
```powershell
3-
PS C:\> New-AzDigitalTwinsDigitalTwinsIdentityObject -Id '************' -Location eastus
3+
New-AzDigitalTwinsDigitalTwinsIdentityObject -Id '************' -Location eastus
4+
```
45

6+
```output
57
EndpointName Location ResourceGroupName ResourceName SubscriptionId
68
------------ -------- ----------------- ------------ --------------
79
eastus

0 commit comments

Comments
 (0)