Skip to content

Commit 46443a5

Browse files
CaptainFanZzzZiyue Zheng
andauthored
format the help markdown files of Az.ConnectedNetwork in generation (#18773)
* format the help markdown files of Az.ConnectedNetwork in generation * format the help markdown files of Az.ConnectedNetwork in generation Co-authored-by: Ziyue Zheng <[email protected]>
1 parent 4c63b93 commit 46443a5

File tree

62 files changed

+354
-276
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+354
-276
lines changed

src/ConnectedNetwork/docs/Get-AzConnectedNetworkDevice.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ Gets information about the specified device.
4242

4343
### Example 1: Get-AzConnectedNetworkDevice via Resource Group and Resource name
4444
```powershell
45-
PS C:\> Get-AzConnectedNetworkDevice -ResourceGroupName myResources -Name myMecDevice
46-
45+
Get-AzConnectedNetworkDevice -ResourceGroupName myResources -Name myMecDevice
46+
```
4747

48+
```output
4849
DeviceType : AzureStackEdge
4950
Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice
5051
Location : westcentralus
@@ -68,10 +69,11 @@ Getting information about the NFM device in resource group myResources with name
6869

6970
### Example 2: Get-AzConnectedNetworkDevice via Identity
7071
```powershell
71-
PS C:\> $mecDevice = @{ DeviceName = "myMecDevice1"; Location = "eastus"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
72-
PS C:\> Get-AzConnectedNetworkDevice -InputObject $mecDevice
73-
72+
$mecDevice = @{ DeviceName = "myMecDevice1"; Location = "eastus"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
73+
Get-AzConnectedNetworkDevice -InputObject $mecDevice
74+
```
7475

76+
```output
7577
DeviceType : AzureStackEdge
7678
Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice1
7779
Location : eastus

src/ConnectedNetwork/docs/Get-AzConnectedNetworkDeviceRegistrationKey.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ List the registration key for the device.
2424

2525
### Example 1: Get-AzConnectedNetworkDeviceRegistrationKey using Resource Group, Resource name
2626
```powershell
27-
PS C:\> Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName myMecDevice -ResourceGroupName myResources
27+
Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName myMecDevice -ResourceGroupName myResources
28+
```
2829

30+
```output
2931
eyJNZWNEZXZpY2VUcmFuc2llbnRBdXRoS2V5IjoiMTIzNCIsIk1lY0RldmljZUF1dGhLZXlTdGFydFRpbWUiOiIyMDIxLTExLTIyVDA5OjQ2OjQwLjY0ODExOTFaIiwiU2VydmljZUJ1c1F1ZXVlTmFtZSI6ImFiY2QtMTIzNCIsIkFBREVuZHBvaW50IjpudWxsLCJBQURBdWRpZW5jZSI6bnVsbCwiQXJtUmVzb3VyY2VJZCI6bnVsbCwiTWVjQ29udHJvbGxlckVuZHBvaW50IjoiaHR0cHM6Ly93ZXN0Y2VudHJhbHVzLXByb2QubWVjZGV2aWNlLmF6dXJlLmNvbTo0NDMiLCJEYmVEZXZpY2VJZCI6bnVsbCwiUmVzb3VyY2VVbmlxdWVJZCI6IjEyMy1hYmMtMTIzIiwiU3Vic2NyaXB0aW9uSWQiOiJ4eHh4LTEyMzQteHh4eC0xMjM0IiwiUmVzb3VyY2VHcm91cE5hbWUiOiJzYW1wbGVSR25hbWUiLCJQcm92aWRlck5hbWVzcGFjZSI6Ik1pY3Jvc29mdC5IeWJyaWROZXR3b3JrIiwiUmVzb3VyY2VUeXBlIjoiRGV2aWNlcyIsIlJlc291cmNlVHlwZU5hbWUiOiJJREMtRGV2aWNlNC1XZXN0Q2VudHJhbCJ9
3032
```
3133

@@ -34,8 +36,10 @@ To register the device, use the commandlet Invoke-MecRegister with the registrat
3436

3537
### Example 2: Get-AzConnectedNetworkDeviceRegistrationKey using Resource Group, Resource name and Subscription Id
3638
```powershell
37-
PS C:\> Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName myMecDevice -ResourceGroupName myResources -SubscriptionId xxxxx-00000-xxxxx-00000
39+
Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName myMecDevice -ResourceGroupName myResources -SubscriptionId xxxxx-00000-xxxxx-00000
40+
```
3841

42+
```output
3943
eyJNZWNEZXZpY2VUcmFuc2llbnRBdXRoS2V5IjoiMTIzNCIsIk1lY0RldmljZUF1dGhLZXlTdGFydFRpbWUiOiIyMDIxLTExLTIyVDA5OjQ2OjQwLjY0ODExOTFaIiwiU2VydmljZUJ1c1F1ZXVlTmFtZSI6ImFiY2QtMTIzNCIsIkFBREVuZHBvaW50IjpudWxsLCJBQURBdWRpZW5jZSI6bnVsbCwiQXJtUmVzb3VyY2VJZCI6bnVsbCwiTWVjQ29udHJvbGxlckVuZHBvaW50IjoiaHR0cHM6Ly93ZXN0Y2VudHJhbHVzLXByb2QubWVjZGV2aWNlLmF6dXJlLmNvbTo0NDMiLCJEYmVEZXZpY2VJZCI6bnVsbCwiUmVzb3VyY2VVbmlxdWVJZCI6IjEyMy1hYmMtMTIzIiwiU3Vic2NyaXB0aW9uSWQiOiJ4eHh4LTEyMzQteHh4eC0xMjM0IiwiUmVzb3VyY2VHcm91cE5hbWUiOiJzYW1wbGVSR25hbWUiLCJQcm92aWRlck5hbWVzcGFjZSI6Ik1pY3Jvc29mdC5IeWJyaWROZXR3b3JrIiwiUmVzb3VyY2VUeXBlIjoiRGV2aWNlcyIsIlJlc291cmNlVHlwZU5hbWUiOiJJREMtRGV2aWNlNC1XZXN0Q2VudHJhbCJ9
4044
```
4145

src/ConnectedNetwork/docs/Get-AzConnectedNetworkFunction.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ Gets information about the specified network function resource.
4242

4343
### Example 1: Get-AzConnectedNetworkFunction via Resource group and Resource name
4444
```powershell
45-
PS C:\> Get-AzConnectedNetworkFunction -Name myVnf -ResourceGroupName myResources
46-
45+
Get-AzConnectedNetworkFunction -Name myVnf -ResourceGroupName myResources
46+
```
4747

48+
```output
4849
ContainerConfiguration : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionPropertiesFormatNetworkFunctionContainerConfigurations
4950
DeviceId : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMec
5051
Etag : "0000a530-0000-3400-0000-615c10fa0000"
@@ -76,10 +77,11 @@ Getting information about the network function in resource group myResources wit
7677

7778
### Example 2: Get-AzConnectedNetworkFunction via Identity
7879
```powershell
79-
PS C:\> $vnf = @{ NetworkFunctionName = "myVnf1"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
80-
PS C:\> Get-AzConnectedNetworkFunction -InputObject $vnf
81-
80+
$vnf = @{ NetworkFunctionName = "myVnf1"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
81+
Get-AzConnectedNetworkFunction -InputObject $vnf
82+
```
8283

84+
```output
8385
ContainerConfiguration : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionPropertiesFormatNetworkFunctionContainerConfigurations
8486
DeviceId : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMec1
8587
Etag : "sampleEtagValue"

src/ConnectedNetwork/docs/Get-AzConnectedNetworkFunctionVendor.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ Lists all the available vendor and sku information.
2424

2525
### Example 1: Get-AzConnectedNetworkFunctionVendor
2626
```powershell
27-
PS C:\> Get-AzConnectedNetworkFunctionVendor
27+
Get-AzConnectedNetworkFunctionVendor
28+
```
2829

30+
```output
2931
SkuList VendorName
3032
------- ----------
3133
{vendor-sku, vendor-sku1, vendor-sku2, vendor-sku3, vendor-sku4, vendor-sku4, vendor-sku5...} myVendor
@@ -37,8 +39,10 @@ Getting information about the vendors and their skus
3739

3840
### Example 2: Get-AzConnectedNetworkFunctionVendor via Subscription Id
3941
```powershell
40-
PS C:\> Get-AzConnectedNetworkFunctionVendor -SubscriptionId "xxxxx-00000-xxxxx-00000"
42+
Get-AzConnectedNetworkFunctionVendor -SubscriptionId "xxxxx-00000-xxxxx-00000"
43+
```
4144

45+
```output
4246
SkuList VendorName
4347
------- ----------
4448
{vendor1-sku, vendor1-sku2} myVendor1

src/ConnectedNetwork/docs/Get-AzConnectedNetworkVendor.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ Gets information about the specified vendor.
3636

3737
### Example 1: Get-AzConnectedNetworkVendor using vendor name
3838
```powershell
39-
PS C:\> Get-AzConnectedNetworkVendor -Name myVendor
40-
39+
Get-AzConnectedNetworkVendor -Name myVendor
40+
```
4141

42+
```output
4243
Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor
4344
Name : myVendor
4445
ProvisioningState : Succeeded
@@ -58,10 +59,11 @@ Getting information about the vendor with vendor name myVendor.
5859

5960
### Example 2: Get-AzConnectedNetworkVendor using Identity
6061
```powershell
61-
PS C:\> $vendor = @{ VendorName = "myVendor1"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
62-
PS C:\> Get-AzConnectedNetworkVendor -InputObject $vendor
63-
62+
$vendor = @{ VendorName = "myVendor1"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
63+
Get-AzConnectedNetworkVendor -InputObject $vendor
64+
```
6465

66+
```output
6567
Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor1
6668
Name : myVendor1
6769
ProvisioningState : Succeeded

src/ConnectedNetwork/docs/Get-AzConnectedNetworkVendorFunction.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Gets information about the specified vendor network function.
3737

3838
### Example 1: Get-AzConnectedNetworkVendorFunction via Location Name, Service Key and Subscription
3939
```powershell
40-
PS C:\> Get-AzConnectedNetworkVendorFunction -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor
40+
Get-AzConnectedNetworkVendorFunction -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor
41+
```
4142

43+
```output
4244
Id : /subscriptions/xxxx-3333-xxxx-3333/providers/Microsoft.HybridNetwork/locations/centraluseuap/vendors/myVendor/networkfunctions/1b69005b-9168-4d74-a371-d4c4f6a521d
4345
0
4446
Name : 1234-abcd-4321-dcba
@@ -63,9 +65,11 @@ Service key can be obtained when getting details of network funcrtion or when cr
6365

6466
### Example 2: Get-AzConnectedNetworkVendorFunction via Identity
6567
```powershell
66-
PS C:\> $vendorNF = @{ ServiceKey = "1234-abcd-4321-dcba"; VendorName = "myVendor"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"}
67-
PS C:\> Get-AzConnectedNetworkVendorFunction -InputObject $vendorNF
68+
$vendorNF = @{ ServiceKey = "1234-abcd-4321-dcba"; VendorName = "myVendor"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"}
69+
Get-AzConnectedNetworkVendorFunction -InputObject $vendorNF
70+
```
6871

72+
```output
6973
Id : /subscriptions/xxxx-3333-xxxx-3333/providers/Microsoft.HybridNetwork/locations/centraluseuap/vendors/myVendor/networkfunctions/1b69005b-9168-4d74-a371-d4c4f6a521d
7074
0
7175
Name : 1234-abcd-4321-dcba

src/ConnectedNetwork/docs/Get-AzConnectedNetworkVendorFunctionRoleInstance.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Gets the information of role instance of vendor network function.
3737

3838
### Example 1: Get-AzConnectedNetworkVendorFunctionRoleInstance via Location, Service key, vendor name and role name
3939
```powershell
40-
PS C:\> Get-AzConnectedNetworkVendorFunctionRoleInstance -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor -Name hpehss
40+
Get-AzConnectedNetworkVendorFunctionRoleInstance -LocationName centraluseuap -ServiceKey 1234-abcd-4321-dcba -SubscriptionId xxxx-3333-xxxx-3333 -VendorName myVendor -Name hpehss
41+
```
4142

43+
```output
4244
Id :
4345
Name : hpehss
4446
OperationalState : Running
@@ -58,9 +60,11 @@ Getting the role instance information of role hpehss with Location centraluseuap
5860

5961
### Example 2: Get-AzConnectedNetworkVendorFunctionRoleInstance via Identity
6062
```powershell
61-
PS C:\> $role = @{ RoleInstanceName = "hpehss"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"; VendorName = "myVendor"; serviceKey = "1234-abcd-4321-dcba"}
62-
PS C:\> Get-AzConnectedNetworkVendorFunctionRoleInstance -InputObject $role
63+
$role = @{ RoleInstanceName = "hpehss"; LocationName = "centraluseuap"; SubscriptionId = "xxxx-3333-xxxx-3333"; VendorName = "myVendor"; serviceKey = "1234-abcd-4321-dcba"}
64+
Get-AzConnectedNetworkVendorFunctionRoleInstance -InputObject $role
65+
```
6366

67+
```output
6468
Id :
6569
Name : hpehss
6670
OperationalState : Stopped

src/ConnectedNetwork/docs/Get-AzConnectedNetworkVendorSku.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Gets information about the specified sku.
3737

3838
### Example 1: Get-AzConnectedNetworkVendorSku using Vendor name and Subscription Id
3939
```powershell
40-
PS C:\> Get-AzConnectedNetworkVendorSku -VendorName myVendor -SubscriptionId xxxxx-22222-xxxxx-22222
40+
Get-AzConnectedNetworkVendorSku -VendorName myVendor -SubscriptionId xxxxx-22222-xxxxx-22222
41+
```
4142

43+
```output
4244
DeploymentMode : PrivateEdgeZone
4345
Id : /subscriptions/xxxxx-22222-xxxxx-22222/providers/Microsoft.HybridNetwork/vendors/myVendor/VendorSkus/mySku
4446
ManagedApplicationParameter : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.VendorSkuPropertiesFormatManagedApplicationParameters

src/ConnectedNetwork/docs/Get-AzConnectedNetworkVendorSkuPreview.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Gets the preview information of a vendor sku.
3737

3838
### Example 1: Get-AzConnectedNetworkVendorSkuPreview using sku name, vendor name and preview subscription
3939
```powershell
40-
PS C:\> Get-AzConnectedNetworkVendorSkuPreview -SkuName mySku -VendorName myVendor -PreviewSubscription xxxxx-22222-xxxxx-22222
40+
Get-AzConnectedNetworkVendorSkuPreview -SkuName mySku -VendorName myVendor -PreviewSubscription xxxxx-22222-xxxxx-22222
41+
```
4142

43+
```output
4244
Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor/vendorSkus/mySku/previewSubscriptions/xxxxx-22222-xxxxx-22222
4345
Name : xxxxx-22222-xxxxx-22222
4446
ProvisioningState : Succeeded
@@ -57,9 +59,11 @@ Getting the preview information of a vendor sku mySku with vendor myVendor for t
5759

5860
### Example 2: Get-AzConnectedNetworkVendorSkuPreview via Identity
5961
```powershell
60-
PS C:\> $skuPreview = @{ SkuName = "mySku"; VendorName = "myVendor"; PreviewSubscription = "xxxxx-22222-xxxxx-22222"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
61-
PS C:\> Get-AzConnectedNetworkVendorSkuPreview -InputObject $skuPreview
62+
$skuPreview = @{ SkuName = "mySku"; VendorName = "myVendor"; PreviewSubscription = "xxxxx-22222-xxxxx-22222"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
63+
Get-AzConnectedNetworkVendorSkuPreview -InputObject $skuPreview
64+
```
6265

66+
```output
6367
Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor/vendorSkus/mySku/previewSubscriptions/xxxxx-22222-xxxxx-22222
6468
Name : xxxxx-22222-xxxxx-22222
6569
ProvisioningState : Succeeded

src/ConnectedNetwork/docs/New-AzConnectedNetworkAzureStackEdgeObject.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 AzureStackEdgeFormat
2323

2424
### Example 1: Create a in-memory stored AzureStackEdgeFormat object for creating the device
2525
```powershell
26-
PS C:\> New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse1"
26+
New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse1"
27+
```
2728

29+
```output
2830
eviceType ProvisioningState Status
2931
---------- ----------------- ------
3032
AzureStackEdge

0 commit comments

Comments
 (0)