From 4a08552faa2f8aed166b093750aec69f7d2a4e6e Mon Sep 17 00:00:00 2001 From: "evan1126@" Date: Tue, 15 Feb 2022 15:04:09 +0800 Subject: [PATCH 1/2] Split Az.EdgeOrder Examples --- src/EdgeOrder/help/Get-AzEdgeOrder.md | 6 ++-- src/EdgeOrder/help/Get-AzEdgeOrderAddress.md | 6 ++-- .../help/Get-AzEdgeOrderConfiguration.md | 12 ++++--- src/EdgeOrder/help/Get-AzEdgeOrderItem.md | 6 ++-- .../help/Get-AzEdgeOrderProductFamily.md | 6 ++-- .../Get-AzEdgeOrderProductFamilyMetadata.md | 6 ++-- .../help/Invoke-AzEdgeOrderReturnOrderItem.md | 2 +- src/EdgeOrder/help/New-AzEdgeOrderAddress.md | 12 ++++--- .../New-AzEdgeOrderContactDetailsObject.md | 2 ++ ...New-AzEdgeOrderFilterablePropertyObject.md | 6 ++-- ...w-AzEdgeOrderHierarchyInformationObject.md | 6 ++-- src/EdgeOrder/help/New-AzEdgeOrderItem.md | 36 ++++++++++--------- .../New-AzEdgeOrderOrderItemDetailsObject.md | 4 +-- .../help/New-AzEdgeOrderPreferencesObject.md | 2 +- .../New-AzEdgeOrderShippingAddressObject.md | 4 ++- .../help/Remove-AzEdgeOrderAddress.md | 2 +- .../help/Update-AzEdgeOrderAddress.md | 8 ++--- src/EdgeOrder/help/Update-AzEdgeOrderItem.md | 10 +++--- 18 files changed, 82 insertions(+), 54 deletions(-) diff --git a/src/EdgeOrder/help/Get-AzEdgeOrder.md b/src/EdgeOrder/help/Get-AzEdgeOrder.md index 7c83f430ba68..4227e42c7b47 100644 --- a/src/EdgeOrder/help/Get-AzEdgeOrder.md +++ b/src/EdgeOrder/help/Get-AzEdgeOrder.md @@ -36,9 +36,11 @@ Gets an order. ### Example 1: Get order details ```powershell -PS C:\> $order = Get-AzEdgeOrder -Name pwOrderItem11 -SubscriptionId "SubscriptionId" -Location "eastus" -ResourceGroupName "resourceGroupName" -PS C:\> $order | fl +$order = Get-AzEdgeOrder -Name pwOrderItem11 -SubscriptionId "SubscriptionId" -Location "eastus" -ResourceGroupName "resourceGroupName" +$order | fl +``` +```output CurrentStageDisplayName : CurrentStageName : Placed CurrentStageStartTime : 11/16/2021 10:35:00 AM diff --git a/src/EdgeOrder/help/Get-AzEdgeOrderAddress.md b/src/EdgeOrder/help/Get-AzEdgeOrderAddress.md index e8095b7c28de..1659879de14b 100644 --- a/src/EdgeOrder/help/Get-AzEdgeOrderAddress.md +++ b/src/EdgeOrder/help/Get-AzEdgeOrderAddress.md @@ -37,9 +37,11 @@ Gets information about the specified address. ### Example 1: Get address details ```powershell -PS C:\> $address = Get-AzEdgeOrderAddress -SubscriptionId SubscriptionId -ResourceGroupName "resourceGroupName" -PS C:\> $address | fl +$address = Get-AzEdgeOrderAddress -SubscriptionId SubscriptionId -ResourceGroupName "resourceGroupName" +$address | fl +``` +```output AddressValidationStatus : Valid ContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails Id : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/addresses/pwvalidaddress diff --git a/src/EdgeOrder/help/Get-AzEdgeOrderConfiguration.md b/src/EdgeOrder/help/Get-AzEdgeOrderConfiguration.md index d1cb7645dba4..46afb94715da 100644 --- a/src/EdgeOrder/help/Get-AzEdgeOrderConfiguration.md +++ b/src/EdgeOrder/help/Get-AzEdgeOrderConfiguration.md @@ -24,12 +24,14 @@ This method provides the list of configurations for the given product family, pr ### Example 1: Get configuration details ```powershell -PS C:\> $configuration = Get-AzEdgeOrderConfiguration -SubscriptionId SubscriptionId -ConfigurationFilter @(@{"HierarchyInformation"=$HierarchyInformation; "FilterableProperty"= @($filterableProperty)}) -PS C:\> $filterableProperty = New-AzEdgeOrderFilterablePropertyObject -Type "ShipToCountries" -SupportedValue @("US") -PS C:\> $HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" -PS C:\> $configuration = Get-AzEdgeOrderConfiguration -SubscriptionId SubscriptionId -ConfigurationFilter @(@{"HierarchyInformation"=$HierarchyInformation; "FilterableProperty"= @($filterableProperty)}) -PS C:\> $configuration +$configuration = Get-AzEdgeOrderConfiguration -SubscriptionId SubscriptionId -ConfigurationFilter @(@{"HierarchyInformation"=$HierarchyInformation; "FilterableProperty"= @($filterableProperty)}) +$filterableProperty = New-AzEdgeOrderFilterablePropertyObject -Type "ShipToCountries" -SupportedValue @("US") +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$configuration = Get-AzEdgeOrderConfiguration -SubscriptionId SubscriptionId -ConfigurationFilter @(@{"HierarchyInformation"=$HierarchyInformation; "FilterableProperty"= @($filterableProperty)}) +$configuration +``` +```output AvailabilityInformationAvailabilityStage : Available AvailabilityInformationDisabledReason : None AvailabilityInformationDisabledReasonMessage : diff --git a/src/EdgeOrder/help/Get-AzEdgeOrderItem.md b/src/EdgeOrder/help/Get-AzEdgeOrderItem.md index 4727b04fd7c6..dd799a73a427 100644 --- a/src/EdgeOrder/help/Get-AzEdgeOrderItem.md +++ b/src/EdgeOrder/help/Get-AzEdgeOrderItem.md @@ -37,9 +37,11 @@ Gets an order item. ### Example 1: Get orderItem details ```powershell -PS C:\> $orderItem = Get-AzEdgeOrderItem -Name examplePowershell -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" -PS C:\> $ordderItem | fl +$orderItem = Get-AzEdgeOrderItem -Name examplePowershell -SubscriptionId "SubscriptionId" -ResourceGroupName "resourceGroupName" +$ordderItem | fl +``` +```output ForwardAddressContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails ForwardAddressShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress ForwardAddressValidationStatus : Valid diff --git a/src/EdgeOrder/help/Get-AzEdgeOrderProductFamily.md b/src/EdgeOrder/help/Get-AzEdgeOrderProductFamily.md index 2e65caebe41c..bdf696565894 100644 --- a/src/EdgeOrder/help/Get-AzEdgeOrderProductFamily.md +++ b/src/EdgeOrder/help/Get-AzEdgeOrderProductFamily.md @@ -24,9 +24,11 @@ This method provides the list of product families for the given subscription. ### Example 1: Get details of specific productFamilies ```powershell -PS C:\> $familyDetails = Get-AzEdgeOrderProductFamily -SubscriptionId SubscriptionId -FilterableProperty @{"azurestackedge"=@($filterableProperty)} -Expand "configurations" -PS C:\> $familyDetails.ProductLine.Product.Configuration.HierarchyInformation +$familyDetails = Get-AzEdgeOrderProductFamily -SubscriptionId SubscriptionId -FilterableProperty @{"azurestackedge"=@($filterableProperty)} -Expand "configurations" +$familyDetails.ProductLine.Product.Configuration.HierarchyInformation +``` +```output ConfigurationName ProductFamilyName ProductLineName ProductName ----------------- ----------------- --------------- ----------- edgep_high azurestackedge azurestackedge azurestackedgegpu diff --git a/src/EdgeOrder/help/Get-AzEdgeOrderProductFamilyMetadata.md b/src/EdgeOrder/help/Get-AzEdgeOrderProductFamilyMetadata.md index 68a376e14fae..e0f7b31b17af 100644 --- a/src/EdgeOrder/help/Get-AzEdgeOrderProductFamilyMetadata.md +++ b/src/EdgeOrder/help/Get-AzEdgeOrderProductFamilyMetadata.md @@ -24,9 +24,11 @@ This method provides the list of product families metadata for the given subscri ### Example 1: Gets available product families on procured subscription ```powershell -PS C:\> $productFamilyMeta = Get-AzEdgeOrderProductFamilyMetadata -SubscriptionId SubscriptionId -PS C:\> $productFamilyMeta.HierarchyInformation +$productFamilyMeta = Get-AzEdgeOrderProductFamilyMetadata -SubscriptionId SubscriptionId +$productFamilyMeta.HierarchyInformation +``` +```output ConfigurationName ProductFamilyName ProductLineName ProductName ----------------- ----------------- --------------- ----------- azurestackedge diff --git a/src/EdgeOrder/help/Invoke-AzEdgeOrderReturnOrderItem.md b/src/EdgeOrder/help/Invoke-AzEdgeOrderReturnOrderItem.md index 4cc74f9ec092..f1387f6a3b15 100644 --- a/src/EdgeOrder/help/Invoke-AzEdgeOrderReturnOrderItem.md +++ b/src/EdgeOrder/help/Invoke-AzEdgeOrderReturnOrderItem.md @@ -35,7 +35,7 @@ Return order item. ### Example 1: Command to initiate orderItem return ```powershell -PS C:\>Invoke-AzEdgeOrderReturnOrderItem -OrderItemName "OrderItem-211115074927900249117427" -ResourceGroupName "resourceGroupName" -ReturnReason "Test Order Return" -SubscriptionId "SubscriptionId" +Invoke-AzEdgeOrderReturnOrderItem -OrderItemName "OrderItem-211115074927900249117427" -ResourceGroupName "resourceGroupName" -ReturnReason "Test Order Return" -SubscriptionId "SubscriptionId" ``` Invoke orderItem return diff --git a/src/EdgeOrder/help/New-AzEdgeOrderAddress.md b/src/EdgeOrder/help/New-AzEdgeOrderAddress.md index 07d815491c2b..4bfbd661bf0e 100644 --- a/src/EdgeOrder/help/New-AzEdgeOrderAddress.md +++ b/src/EdgeOrder/help/New-AzEdgeOrderAddress.md @@ -27,9 +27,9 @@ Existing address can be updated with this API ### Example 1: Create a new address ```powershell -PS C:\> $contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName ContactName -EmailList @("emailId") -Phone Phone -PS C:\> $ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" -PS C:\> $DebugPreference = "Continue" +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName ContactName -EmailList @("emailId") -Phone Phone +$ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$DebugPreference = "Continue" # You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when creation command fails. # { # "Error": { @@ -41,9 +41,11 @@ PS C:\> $DebugPreference = "Continue" # "Target": null # } # } -PS C:\> $address = New-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -ContactDetail $contactDetail -SubscriptionId SubscriptionId -ShippingAddress $ShippingDetails -Location "eastus" -PS C:\> $address | fl +$address = New-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -ContactDetail $contactDetail -SubscriptionId SubscriptionId -ShippingAddress $ShippingDetails -Location "eastus" +$address | fl +``` +```output AddressValidationStatus : Valid ContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails Id : /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestPwAddress diff --git a/src/EdgeOrder/help/New-AzEdgeOrderContactDetailsObject.md b/src/EdgeOrder/help/New-AzEdgeOrderContactDetailsObject.md index e4107ce81a6e..b56ed6eca193 100644 --- a/src/EdgeOrder/help/New-AzEdgeOrderContactDetailsObject.md +++ b/src/EdgeOrder/help/New-AzEdgeOrderContactDetailsObject.md @@ -25,7 +25,9 @@ Create an in-memory object for ContactDetails. ### Example 1: Contact details object ```powershell $contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName ContactName -EmailList @("emailId") -Phone Phone +``` +```output ContactName : random EmailList : {"emailId"} Mobile : diff --git a/src/EdgeOrder/help/New-AzEdgeOrderFilterablePropertyObject.md b/src/EdgeOrder/help/New-AzEdgeOrderFilterablePropertyObject.md index 341972111150..f7aa900b0f95 100644 --- a/src/EdgeOrder/help/New-AzEdgeOrderFilterablePropertyObject.md +++ b/src/EdgeOrder/help/New-AzEdgeOrderFilterablePropertyObject.md @@ -24,9 +24,11 @@ Create an in-memory object for FilterableProperty. ### Example 1: Filterable property object ```powershell -PS C:\> $filterableProperty = New-AzEdgeOrderFilterablePropertyObject -Type "ShipToCountries" -SupportedValue @("US") -PS C:\> $filterableProperty | fl +$filterableProperty = New-AzEdgeOrderFilterablePropertyObject -Type "ShipToCountries" -SupportedValue @("US") +$filterableProperty | fl +``` +```output SupportedValue : {US} Type : ShipToCountries ``` diff --git a/src/EdgeOrder/help/New-AzEdgeOrderHierarchyInformationObject.md b/src/EdgeOrder/help/New-AzEdgeOrderHierarchyInformationObject.md index 20e2032375dc..fe87113f3142 100644 --- a/src/EdgeOrder/help/New-AzEdgeOrderHierarchyInformationObject.md +++ b/src/EdgeOrder/help/New-AzEdgeOrderHierarchyInformationObject.md @@ -24,9 +24,11 @@ Create an in-memory object for HierarchyInformation. ### Example 1: Creates hierarchy information object ```powershell -PS C:\> $HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" -PS C:\> $HierarchyInformation | fl +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$HierarchyInformation | fl +``` +```output ConfigurationName : EdgeP_High ProductFamilyName : azurestackedge ProductLineName : azurestackedge diff --git a/src/EdgeOrder/help/New-AzEdgeOrderItem.md b/src/EdgeOrder/help/New-AzEdgeOrderItem.md index 5091933e294f..a21eb357e20b 100644 --- a/src/EdgeOrder/help/New-AzEdgeOrderItem.md +++ b/src/EdgeOrder/help/New-AzEdgeOrderItem.md @@ -28,14 +28,14 @@ Existing order item cannot be updated with this api and should instead be update ### Example 1: Creates a new orderItem ```powershell -PS C:\> $contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName ContactName -EmailList @("emailId") -Phone Phone -PS C:\> $ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" -PS C:\> $HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" -PS C:\> $details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} -PS C:\> $orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName ResourceGroup -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/"SubscriptionId"/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails - -PS C:\> $orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/"SubscriptionId"/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails -PS C:\> $DebugPreference = "Continue" +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName ContactName -EmailList @("emailId") -Phone Phone +$ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} +$orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName ResourceGroup -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/"SubscriptionId"/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails + +$orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/"SubscriptionId"/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails +$DebugPreference = "Continue" # You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when creation command fails. # { # "Error": { @@ -47,9 +47,11 @@ PS C:\> $DebugPreference = "Continue" # "Target": null # } # } -PS C:\> $orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/"SubscriptionId"/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails -PS C:\> $orderItem | fl +$orderItem = New-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/"SubscriptionId"/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwOrderItem11" -OrderItemDetail $details -SubscriptionId SubscriptionId -ForwardShippingAddress $ShippingDetails +$orderItem | fl +``` +```output ForwardAddressContactDetail : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ContactDetails ForwardAddressShippingAddress : Microsoft.Azure.PowerShell.Cmdlets.EdgeOrder.Models.Api20211201.ShippingAddress ForwardAddressValidationStatus : Valid @@ -72,13 +74,15 @@ Creates a new orderItem. ### Example 2: Creates a new orderItem with preference set for transport, encryption and management resource ```powershell -PS C:\> $contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList $env.EmailList -Phone $env.Phone -PS C:\> $ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 $env.StreetAddress1 -StateOrProvince $env.StateOrProvince -Country $env.Country -City $env.City -PostalCode $env.PostalCode -AddressType $env.AddressType -PS C:\> $HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" -PS C:\> $preference = New-AzEdgeOrderPreferencesObject -EncryptionPreference @{DoubleEncryptionStatus = "Disabled"} -TransportPreference @{PreferredShipmentType = "MicrosoftManaged"} -ManagementResourcePreference @{PreferredManagementResourceId = "/subscriptions/managementSubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/1GPUtest"} -PS C:\> $details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} -Preference $preference -PS C:\> New-AzEdgeOrderItem -Name "OrderItemNameWithPref" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwPrefOrder" -OrderItemDetail $details -SubscriptionId $env.SubscriptionId -ForwardShippingAddress $ShippingDetails +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList $env.EmailList -Phone $env.Phone +$ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 $env.StreetAddress1 -StateOrProvince $env.StateOrProvince -Country $env.Country -City $env.City -PostalCode $env.PostalCode -AddressType $env.AddressType +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$preference = New-AzEdgeOrderPreferencesObject -EncryptionPreference @{DoubleEncryptionStatus = "Disabled"} -TransportPreference @{PreferredShipmentType = "MicrosoftManaged"} -ManagementResourcePreference @{PreferredManagementResourceId = "/subscriptions/managementSubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/1GPUtest"} +$details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} -Preference $preference +New-AzEdgeOrderItem -Name "OrderItemNameWithPref" -ResourceGroupName "resourceGroupName" -ForwardAddressContactDetail $contactDetail -Location "eastus" -OrderId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/pwPrefOrder" -OrderItemDetail $details -SubscriptionId $env.SubscriptionId -ForwardShippingAddress $ShippingDetails +``` +```output Location Name Type -------- ---- ---- eastus OrderItemNameWithPref Microsoft.EdgeOrder/orderItems diff --git a/src/EdgeOrder/help/New-AzEdgeOrderOrderItemDetailsObject.md b/src/EdgeOrder/help/New-AzEdgeOrderOrderItemDetailsObject.md index 67c249c2d5d7..38a40f2b3d15 100644 --- a/src/EdgeOrder/help/New-AzEdgeOrderOrderItemDetailsObject.md +++ b/src/EdgeOrder/help/New-AzEdgeOrderOrderItemDetailsObject.md @@ -24,8 +24,8 @@ Create an in-memory object for OrderItemDetails. ### Example 1: Creates orderItemDetails object. ```powershell -PS C:\> $HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" -PS C:\> $details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} +$HierarchyInformation=New-AzEdgeOrderHierarchyInformationObject -ProductFamilyName "azurestackedge" -ProductLineName "azurestackedge" -ProductName "azurestackedgegpu" -ConfigurationName "EdgeP_High" +$details = New-AzEdgeOrderOrderItemDetailsObject -OrderItemType "Purchase" -ProductDetail @{"HierarchyInformation"=$HierarchyInformation} ``` Create an in-memory object for OrderItemDetails. diff --git a/src/EdgeOrder/help/New-AzEdgeOrderPreferencesObject.md b/src/EdgeOrder/help/New-AzEdgeOrderPreferencesObject.md index 6c00c6c4b900..4a693d6d84df 100644 --- a/src/EdgeOrder/help/New-AzEdgeOrderPreferencesObject.md +++ b/src/EdgeOrder/help/New-AzEdgeOrderPreferencesObject.md @@ -26,7 +26,7 @@ Create an in-memory object for Preferences. ### Example 1: Create a preference object ```powershell -PS C:\> $preference = New-AzEdgeOrderPreferencesObject -EncryptionPreference @{DoubleEncryptionStatus = "Disabled"} -TransportPreference @{PreferredShipmentType = "MicrosoftManaged"} -ManagementResourcePreference @{PreferredManagementResourceId = "/subscriptions/managementSubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/1GPUtest"} +$preference = New-AzEdgeOrderPreferencesObject -EncryptionPreference @{DoubleEncryptionStatus = "Disabled"} -TransportPreference @{PreferredShipmentType = "MicrosoftManaged"} -ManagementResourcePreference @{PreferredManagementResourceId = "/subscriptions/managementSubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/1GPUtest"} ``` Creates a in-memory preference object to set transport, encryption and management resource preference. diff --git a/src/EdgeOrder/help/New-AzEdgeOrderShippingAddressObject.md b/src/EdgeOrder/help/New-AzEdgeOrderShippingAddressObject.md index 593c44ba844e..1ced8fc64cde 100644 --- a/src/EdgeOrder/help/New-AzEdgeOrderShippingAddressObject.md +++ b/src/EdgeOrder/help/New-AzEdgeOrderShippingAddressObject.md @@ -25,10 +25,12 @@ Create an in-memory object for ShippingAddress. ### Example 1: Creates shipping address object ```powershell -PS C:\> $ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" +$ShippingDetails = New-AzEdgeOrderShippingAddressObject -StreetAddress1 "101 TOWNSEND ST" -StateOrProvince "CA" -Country "US" -City "San Francisco" -PostalCode "94107" -AddressType "Commercial" $ShippingDetails | fl +``` +```output AddressType : Commercial City : San Francisco CompanyName : diff --git a/src/EdgeOrder/help/Remove-AzEdgeOrderAddress.md b/src/EdgeOrder/help/Remove-AzEdgeOrderAddress.md index 0237d87e0a84..e81baf5bcd62 100644 --- a/src/EdgeOrder/help/Remove-AzEdgeOrderAddress.md +++ b/src/EdgeOrder/help/Remove-AzEdgeOrderAddress.md @@ -31,7 +31,7 @@ Deletes an address. ### Example 1: Delete address ```powershell -PS C:\> Remove-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId +Remove-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId ``` Delete Address diff --git a/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md b/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md index 9335a4803f04..69d05eb17946 100644 --- a/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md +++ b/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md @@ -33,8 +33,8 @@ Updates the properties of an existing address. ### Example 1: Update address details ```powershell -PS C:\> $contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList @("emailId") -Phone Phone -PS C:\> $DebugPreference = "Continue" +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList @("emailId") -Phone Phone +$DebugPreference = "Continue" # You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when update command fails. # { # "Error": { @@ -46,8 +46,8 @@ PS C:\> $DebugPreference = "Continue" # "Target": null # } # } -PS C:\> $updatedContactInAddress = Update-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId -ContactDetail $contactDetail -ShippingAddres $ShippingDetails -PS C:\> $updatedContactInAddress.ContactDetail.ContactName +$updatedContactInAddress = Update-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId -ContactDetail $contactDetail -ShippingAddres $ShippingDetails +$updatedContactInAddress.ContactDetail.ContactName ContactName2 ``` diff --git a/src/EdgeOrder/help/Update-AzEdgeOrderItem.md b/src/EdgeOrder/help/Update-AzEdgeOrderItem.md index 0fc36c40cebb..0e97ccb3dea2 100644 --- a/src/EdgeOrder/help/Update-AzEdgeOrderItem.md +++ b/src/EdgeOrder/help/Update-AzEdgeOrderItem.md @@ -35,8 +35,8 @@ Updates the properties of an existing order item. ### Example 1: Update orderItem ```powershell -PS C:\> $contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList @("emailId") -Phone Phone -PS C:\> $DebugPreference = "Continue" +$contactDetail = New-AzEdgeOrderContactDetailsObject -ContactName "ContactName2" -EmailList @("emailId") -Phone Phone +$DebugPreference = "Continue" # You can use `$DebugPreference = "Continue"`, with any example/usecase to get exact details of error in below format when update command fails. # { # "Error": { @@ -48,10 +48,12 @@ PS C:\> $DebugPreference = "Continue" # "Target": null # } # } -PS C:\> $updatedOrderItem = Update-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId -ForwardAddressContactDetail $contactDetail +$updatedOrderItem = Update-AzEdgeOrderItem -Name "examplePowershell" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId -ForwardAddressContactDetail $contactDetail -PS C:\> $updatedOrderItem.ForwardAddressContactDetail | fl +$updatedOrderItem.ForwardAddressContactDetail | fl +``` +```output ContactName : ContactName2 EmailList : {useremailId} Mobile : From a291880145ed6ba4973c4abaf2746bdb825cd474 Mon Sep 17 00:00:00 2001 From: "evan1126@" Date: Thu, 24 Feb 2022 11:26:33 +0800 Subject: [PATCH 2/2] fix --- src/EdgeOrder/help/Update-AzEdgeOrderAddress.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md b/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md index 69d05eb17946..d7753c9ecc8d 100644 --- a/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md +++ b/src/EdgeOrder/help/Update-AzEdgeOrderAddress.md @@ -48,6 +48,9 @@ $DebugPreference = "Continue" # } $updatedContactInAddress = Update-AzEdgeOrderAddress -Name "TestPwAddress" -ResourceGroupName "resourceGroupName" -SubscriptionId SubscriptionId -ContactDetail $contactDetail -ShippingAddres $ShippingDetails $updatedContactInAddress.ContactDetail.ContactName +``` + +```output ContactName2 ```