Skip to content
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

format the help markdown files of Az.ConnectedNetwork #18772

Merged
merged 2 commits into from
Jul 1, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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: 7 additions & 5 deletions src/ConnectedNetwork/help/Get-AzConnectedNetworkDevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ Gets information about the specified device.

### Example 1: Get-AzConnectedNetworkDevice via Resource Group and Resource name
```powershell
PS C:\> Get-AzConnectedNetworkDevice -ResourceGroupName myResources -Name myMecDevice

Get-AzConnectedNetworkDevice -ResourceGroupName myResources -Name myMecDevice
```

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

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

$mecDevice = @{ DeviceName = "myMecDevice1"; Location = "eastus"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
Get-AzConnectedNetworkDevice -InputObject $mecDevice
```

```output
DeviceType : AzureStackEdge
Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice1
Location : eastus
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ List the registration key for the device.

### Example 1: Get-AzConnectedNetworkDeviceRegistrationKey using Resource Group, Resource name
```powershell
PS C:\> Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName myMecDevice -ResourceGroupName myResources
Get-AzConnectedNetworkDeviceRegistrationKey -DeviceName myMecDevice -ResourceGroupName myResources
```

```output
eyJNZWNEZXZpY2VUcmFuc2llbnRBdXRoS2V5IjoiMTIzNCIsIk1lY0RldmljZUF1dGhLZXlTdGFydFRpbWUiOiIyMDIxLTExLTIyVDA5OjQ2OjQwLjY0ODExOTFaIiwiU2VydmljZUJ1c1F1ZXVlTmFtZSI6ImFiY2QtMTIzNCIsIkFBREVuZHBvaW50IjpudWxsLCJBQURBdWRpZW5jZSI6bnVsbCwiQXJtUmVzb3VyY2VJZCI6bnVsbCwiTWVjQ29udHJvbGxlckVuZHBvaW50IjoiaHR0cHM6Ly93ZXN0Y2VudHJhbHVzLXByb2QubWVjZGV2aWNlLmF6dXJlLmNvbTo0NDMiLCJEYmVEZXZpY2VJZCI6bnVsbCwiUmVzb3VyY2VVbmlxdWVJZCI6IjEyMy1hYmMtMTIzIiwiU3Vic2NyaXB0aW9uSWQiOiJ4eHh4LTEyMzQteHh4eC0xMjM0IiwiUmVzb3VyY2VHcm91cE5hbWUiOiJzYW1wbGVSR25hbWUiLCJQcm92aWRlck5hbWVzcGFjZSI6Ik1pY3Jvc29mdC5IeWJyaWROZXR3b3JrIiwiUmVzb3VyY2VUeXBlIjoiRGV2aWNlcyIsIlJlc291cmNlVHlwZU5hbWUiOiJJREMtRGV2aWNlNC1XZXN0Q2VudHJhbCJ9
```

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

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

```output
eyJNZWNEZXZpY2VUcmFuc2llbnRBdXRoS2V5IjoiMTIzNCIsIk1lY0RldmljZUF1dGhLZXlTdGFydFRpbWUiOiIyMDIxLTExLTIyVDA5OjQ2OjQwLjY0ODExOTFaIiwiU2VydmljZUJ1c1F1ZXVlTmFtZSI6ImFiY2QtMTIzNCIsIkFBREVuZHBvaW50IjpudWxsLCJBQURBdWRpZW5jZSI6bnVsbCwiQXJtUmVzb3VyY2VJZCI6bnVsbCwiTWVjQ29udHJvbGxlckVuZHBvaW50IjoiaHR0cHM6Ly93ZXN0Y2VudHJhbHVzLXByb2QubWVjZGV2aWNlLmF6dXJlLmNvbTo0NDMiLCJEYmVEZXZpY2VJZCI6bnVsbCwiUmVzb3VyY2VVbmlxdWVJZCI6IjEyMy1hYmMtMTIzIiwiU3Vic2NyaXB0aW9uSWQiOiJ4eHh4LTEyMzQteHh4eC0xMjM0IiwiUmVzb3VyY2VHcm91cE5hbWUiOiJzYW1wbGVSR25hbWUiLCJQcm92aWRlck5hbWVzcGFjZSI6Ik1pY3Jvc29mdC5IeWJyaWROZXR3b3JrIiwiUmVzb3VyY2VUeXBlIjoiRGV2aWNlcyIsIlJlc291cmNlVHlwZU5hbWUiOiJJREMtRGV2aWNlNC1XZXN0Q2VudHJhbCJ9
```

Expand Down
12 changes: 7 additions & 5 deletions src/ConnectedNetwork/help/Get-AzConnectedNetworkFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ Gets information about the specified network function resource.

### Example 1: Get-AzConnectedNetworkFunction via Resource group and Resource name
```powershell
PS C:\> Get-AzConnectedNetworkFunction -Name myVnf -ResourceGroupName myResources

Get-AzConnectedNetworkFunction -Name myVnf -ResourceGroupName myResources
```

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

### Example 2: Get-AzConnectedNetworkFunction via Identity
```powershell
PS C:\> $vnf = @{ NetworkFunctionName = "myVnf1"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
PS C:\> Get-AzConnectedNetworkFunction -InputObject $vnf

$vnf = @{ NetworkFunctionName = "myVnf1"; ResourceGroupName = "myResources"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
Get-AzConnectedNetworkFunction -InputObject $vnf
```

```output
ContainerConfiguration : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.NetworkFunctionPropertiesFormatNetworkFunctionContainerConfigurations
DeviceId : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMec1
Etag : "sampleEtagValue"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ Lists all the available vendor and sku information.

### Example 1: Get-AzConnectedNetworkFunctionVendor
```powershell
PS C:\> Get-AzConnectedNetworkFunctionVendor
Get-AzConnectedNetworkFunctionVendor
```

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

### Example 2: Get-AzConnectedNetworkFunctionVendor via Subscription Id
```powershell
PS C:\> Get-AzConnectedNetworkFunctionVendor -SubscriptionId "xxxxx-00000-xxxxx-00000"
Get-AzConnectedNetworkFunctionVendor -SubscriptionId "xxxxx-00000-xxxxx-00000"
```

```output
SkuList VendorName
------- ----------
{vendor1-sku, vendor1-sku2} myVendor1
Expand Down
12 changes: 7 additions & 5 deletions src/ConnectedNetwork/help/Get-AzConnectedNetworkVendor.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ Gets information about the specified vendor.

### Example 1: Get-AzConnectedNetworkVendor using vendor name
```powershell
PS C:\> Get-AzConnectedNetworkVendor -Name myVendor

Get-AzConnectedNetworkVendor -Name myVendor
```

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

### Example 2: Get-AzConnectedNetworkVendor using Identity
```powershell
PS C:\> $vendor = @{ VendorName = "myVendor1"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
PS C:\> Get-AzConnectedNetworkVendor -InputObject $vendor

$vendor = @{ VendorName = "myVendor1"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
Get-AzConnectedNetworkVendor -InputObject $vendor
```

```output
Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor1
Name : myVendor1
ProvisioningState : Succeeded
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Gets information about the specified vendor network function.

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

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

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

```output
Id : /subscriptions/xxxx-3333-xxxx-3333/providers/Microsoft.HybridNetwork/locations/centraluseuap/vendors/myVendor/networkfunctions/1b69005b-9168-4d74-a371-d4c4f6a521d
0
Name : 1234-abcd-4321-dcba
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Gets the information of role instance of vendor network function.

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

```output
Id :
Name : hpehss
OperationalState : Running
Expand All @@ -58,9 +60,11 @@ Getting the role instance information of role hpehss with Location centraluseuap

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

```output
Id :
Name : hpehss
OperationalState : Stopped
Expand Down
4 changes: 3 additions & 1 deletion src/ConnectedNetwork/help/Get-AzConnectedNetworkVendorSku.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Gets information about the specified sku.

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

```output
DeploymentMode : PrivateEdgeZone
Id : /subscriptions/xxxxx-22222-xxxxx-22222/providers/Microsoft.HybridNetwork/vendors/myVendor/VendorSkus/mySku
ManagedApplicationParameter : Microsoft.Azure.PowerShell.Cmdlets.ConnectedNetwork.Models.Api20210501.VendorSkuPropertiesFormatManagedApplicationParameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Gets the preview information of a vendor sku.

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

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

### Example 2: Get-AzConnectedNetworkVendorSkuPreview via Identity
```powershell
PS C:\> $skuPreview = @{ SkuName = "mySku"; VendorName = "myVendor"; PreviewSubscription = "xxxxx-22222-xxxxx-22222"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
PS C:\> Get-AzConnectedNetworkVendorSkuPreview -InputObject $skuPreview
$skuPreview = @{ SkuName = "mySku"; VendorName = "myVendor"; PreviewSubscription = "xxxxx-22222-xxxxx-22222"; SubscriptionId = "xxxxx-00000-xxxxx-00000"}
Get-AzConnectedNetworkVendorSkuPreview -InputObject $skuPreview
```

```output
Id : /subscriptions/xxxxx-00000-xxxxx-00000/providers/Microsoft.HybridNetwork/vendors/myVendor/vendorSkus/mySku/previewSubscriptions/xxxxx-22222-xxxxx-22222
Name : xxxxx-22222-xxxxx-22222
ProvisioningState : Succeeded
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ Create a in-memory object for AzureStackEdgeFormat

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

```output
eviceType ProvisioningState Status
---------- ----------------- ------
AzureStackEdge
Expand Down
12 changes: 8 additions & 4 deletions src/ConnectedNetwork/help/New-AzConnectedNetworkDevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ Creates or updates a device.

### Example 1: New-AzConnectedNetworkDevice
```powershell
PS C:\> $ase = New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse"
PS C:\> New-AzConnectedNetworkDevice -Name "myMecDevice" -ResourceGroupName "myResources" -Location "eastus" -Property $ase
$ase = New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse"
New-AzConnectedNetworkDevice -Name "myMecDevice" -ResourceGroupName "myResources" -Location "eastus" -Property $ase
```

```output
DeviceType : AzureStackEdge
Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice
Location : eastus
Expand All @@ -51,9 +53,11 @@ Create a device with Device Name with resource myMecDevice name in Resource Grou

### Example 2: New-AzConnectedNetworkDevice
```powershell
PS C:\> $ase = New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse1"
PS C:\> New-AzConnectedNetworkDevice -Name "myMecDevice1" -ResourceGroupName "myResources" -Location "eastus2euap" -Property $ase -SubscriptionId xxxxx-00000-xxxxx-00000
$ase = New-AzConnectedNetworkAzureStackEdgeObject -AzureStackEdgeId "/subscriptions/xxxxx-00000-xxxxx-00000/resourcegroups/myResources/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/myAse1"
New-AzConnectedNetworkDevice -Name "myMecDevice1" -ResourceGroupName "myResources" -Location "eastus2euap" -Property $ase -SubscriptionId xxxxx-00000-xxxxx-00000
```

```output
DeviceType : AzureStackEdge
Id : /subscriptions/xxxxx-00000-xxxxx-00000/resourceGroups/myResources/providers/Microsoft.HybridNetwork/devices/myMecDevice1
Location : eastus
Expand Down
Loading