1. Packages
  2. Azure Native
  3. API Docs
  4. edgeorder
  5. getOrderItemByName
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native.edgeorder.getOrderItemByName

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets an order item.

Uses Azure REST API version 2021-12-01.

Using getOrderItemByName

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOrderItemByName(args: GetOrderItemByNameArgs, opts?: InvokeOptions): Promise<GetOrderItemByNameResult>
function getOrderItemByNameOutput(args: GetOrderItemByNameOutputArgs, opts?: InvokeOptions): Output<GetOrderItemByNameResult>
Copy
def get_order_item_by_name(expand: Optional[str] = None,
                           order_item_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetOrderItemByNameResult
def get_order_item_by_name_output(expand: Optional[pulumi.Input[str]] = None,
                           order_item_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetOrderItemByNameResult]
Copy
func LookupOrderItemByName(ctx *Context, args *LookupOrderItemByNameArgs, opts ...InvokeOption) (*LookupOrderItemByNameResult, error)
func LookupOrderItemByNameOutput(ctx *Context, args *LookupOrderItemByNameOutputArgs, opts ...InvokeOption) LookupOrderItemByNameResultOutput
Copy

> Note: This function is named LookupOrderItemByName in the Go SDK.

public static class GetOrderItemByName 
{
    public static Task<GetOrderItemByNameResult> InvokeAsync(GetOrderItemByNameArgs args, InvokeOptions? opts = null)
    public static Output<GetOrderItemByNameResult> Invoke(GetOrderItemByNameInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOrderItemByNameResult> getOrderItemByName(GetOrderItemByNameArgs args, InvokeOptions options)
public static Output<GetOrderItemByNameResult> getOrderItemByName(GetOrderItemByNameArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:edgeorder:getOrderItemByName
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OrderItemName
This property is required.
Changes to this property will trigger replacement.
string
The name of the order item
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Expand string
$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
OrderItemName
This property is required.
Changes to this property will trigger replacement.
string
The name of the order item
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Expand string
$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
orderItemName
This property is required.
Changes to this property will trigger replacement.
String
The name of the order item
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
expand String
$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
orderItemName
This property is required.
Changes to this property will trigger replacement.
string
The name of the order item
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
expand string
$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
order_item_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the order item
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
expand str
$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
orderItemName
This property is required.
Changes to this property will trigger replacement.
String
The name of the order item
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
expand String
$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.

getOrderItemByName Result

The following output properties are available:

AddressDetails Pulumi.AzureNative.EdgeOrder.Outputs.AddressDetailsResponse
Represents shipping and return address for order item
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
OrderId string
Id of the order to which order item belongs to
OrderItemDetails Pulumi.AzureNative.EdgeOrder.Outputs.OrderItemDetailsResponse
Represents order item details.
StartTime string
Start time of order item
SystemData Pulumi.AzureNative.EdgeOrder.Outputs.SystemDataResponse
Represents resource creation and update time
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>
Resource tags.
AddressDetails AddressDetailsResponse
Represents shipping and return address for order item
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
OrderId string
Id of the order to which order item belongs to
OrderItemDetails OrderItemDetailsResponse
Represents order item details.
StartTime string
Start time of order item
SystemData SystemDataResponse
Represents resource creation and update time
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string
Resource tags.
addressDetails AddressDetailsResponse
Represents shipping and return address for order item
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
orderId String
Id of the order to which order item belongs to
orderItemDetails OrderItemDetailsResponse
Represents order item details.
startTime String
Start time of order item
systemData SystemDataResponse
Represents resource creation and update time
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>
Resource tags.
addressDetails AddressDetailsResponse
Represents shipping and return address for order item
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
orderId string
Id of the order to which order item belongs to
orderItemDetails OrderItemDetailsResponse
Represents order item details.
startTime string
Start time of order item
systemData SystemDataResponse
Represents resource creation and update time
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}
Resource tags.
address_details AddressDetailsResponse
Represents shipping and return address for order item
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
order_id str
Id of the order to which order item belongs to
order_item_details OrderItemDetailsResponse
Represents order item details.
start_time str
Start time of order item
system_data SystemDataResponse
Represents resource creation and update time
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]
Resource tags.
addressDetails Property Map
Represents shipping and return address for order item
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
orderId String
Id of the order to which order item belongs to
orderItemDetails Property Map
Represents order item details.
startTime String
Start time of order item
systemData Property Map
Represents resource creation and update time
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>
Resource tags.

Supporting Types

AdditionalConfigurationResponse

HierarchyInformation This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
Quantity This property is required. int
Quantity of the product.
HierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
Quantity This property is required. int
Quantity of the product.
hierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
quantity This property is required. Integer
Quantity of the product.
hierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
quantity This property is required. number
Quantity of the product.
hierarchy_information This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
quantity This property is required. int
Quantity of the product.
hierarchyInformation This property is required. Property Map
Hierarchy of the product which uniquely identifies the configuration.
quantity This property is required. Number
Quantity of the product.

AddressDetailsResponse

ForwardAddress This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.AddressPropertiesResponse
Customer address and contact details. It should be address resource
ReturnAddress This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.AddressPropertiesResponse
Return shipping address
ForwardAddress This property is required. AddressPropertiesResponse
Customer address and contact details. It should be address resource
ReturnAddress This property is required. AddressPropertiesResponse
Return shipping address
forwardAddress This property is required. AddressPropertiesResponse
Customer address and contact details. It should be address resource
returnAddress This property is required. AddressPropertiesResponse
Return shipping address
forwardAddress This property is required. AddressPropertiesResponse
Customer address and contact details. It should be address resource
returnAddress This property is required. AddressPropertiesResponse
Return shipping address
forward_address This property is required. AddressPropertiesResponse
Customer address and contact details. It should be address resource
return_address This property is required. AddressPropertiesResponse
Return shipping address
forwardAddress This property is required. Property Map
Customer address and contact details. It should be address resource
returnAddress This property is required. Property Map
Return shipping address

AddressPropertiesResponse

AddressValidationStatus This property is required. string
Status of address validation
ContactDetails This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.ContactDetailsResponse
Contact details for the address
ShippingAddress Pulumi.AzureNative.EdgeOrder.Inputs.ShippingAddressResponse
Shipping details for the address
AddressValidationStatus This property is required. string
Status of address validation
ContactDetails This property is required. ContactDetailsResponse
Contact details for the address
ShippingAddress ShippingAddressResponse
Shipping details for the address
addressValidationStatus This property is required. String
Status of address validation
contactDetails This property is required. ContactDetailsResponse
Contact details for the address
shippingAddress ShippingAddressResponse
Shipping details for the address
addressValidationStatus This property is required. string
Status of address validation
contactDetails This property is required. ContactDetailsResponse
Contact details for the address
shippingAddress ShippingAddressResponse
Shipping details for the address
address_validation_status This property is required. str
Status of address validation
contact_details This property is required. ContactDetailsResponse
Contact details for the address
shipping_address ShippingAddressResponse
Shipping details for the address
addressValidationStatus This property is required. String
Status of address validation
contactDetails This property is required. Property Map
Contact details for the address
shippingAddress Property Map
Shipping details for the address

ConfigurationDeviceDetailsResponse

DeviceDetails This property is required. List<Pulumi.AzureNative.EdgeOrder.Inputs.DeviceDetailsResponse>
List of device details.
HierarchyInformation This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
IdentificationType This property is required. string
Identification type of the configuration.
Quantity This property is required. int
Quantity of the product.
DisplayInfo Pulumi.AzureNative.EdgeOrder.Inputs.DisplayInfoResponse
Display details of the product.
DeviceDetails This property is required. []DeviceDetailsResponse
List of device details.
HierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
IdentificationType This property is required. string
Identification type of the configuration.
Quantity This property is required. int
Quantity of the product.
DisplayInfo DisplayInfoResponse
Display details of the product.
deviceDetails This property is required. List<DeviceDetailsResponse>
List of device details.
hierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
identificationType This property is required. String
Identification type of the configuration.
quantity This property is required. Integer
Quantity of the product.
displayInfo DisplayInfoResponse
Display details of the product.
deviceDetails This property is required. DeviceDetailsResponse[]
List of device details.
hierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
identificationType This property is required. string
Identification type of the configuration.
quantity This property is required. number
Quantity of the product.
displayInfo DisplayInfoResponse
Display details of the product.
device_details This property is required. Sequence[DeviceDetailsResponse]
List of device details.
hierarchy_information This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the configuration.
identification_type This property is required. str
Identification type of the configuration.
quantity This property is required. int
Quantity of the product.
display_info DisplayInfoResponse
Display details of the product.
deviceDetails This property is required. List<Property Map>
List of device details.
hierarchyInformation This property is required. Property Map
Hierarchy of the product which uniquely identifies the configuration.
identificationType This property is required. String
Identification type of the configuration.
quantity This property is required. Number
Quantity of the product.
displayInfo Property Map
Display details of the product.

ContactDetailsResponse

ContactName This property is required. string
Contact name of the person.
EmailList This property is required. List<string>
List of Email-ids to be notified about job progress.
Phone This property is required. string
Phone number of the contact person.
Mobile string
Mobile number of the contact person.
PhoneExtension string
Phone extension number of the contact person.
ContactName This property is required. string
Contact name of the person.
EmailList This property is required. []string
List of Email-ids to be notified about job progress.
Phone This property is required. string
Phone number of the contact person.
Mobile string
Mobile number of the contact person.
PhoneExtension string
Phone extension number of the contact person.
contactName This property is required. String
Contact name of the person.
emailList This property is required. List<String>
List of Email-ids to be notified about job progress.
phone This property is required. String
Phone number of the contact person.
mobile String
Mobile number of the contact person.
phoneExtension String
Phone extension number of the contact person.
contactName This property is required. string
Contact name of the person.
emailList This property is required. string[]
List of Email-ids to be notified about job progress.
phone This property is required. string
Phone number of the contact person.
mobile string
Mobile number of the contact person.
phoneExtension string
Phone extension number of the contact person.
contact_name This property is required. str
Contact name of the person.
email_list This property is required. Sequence[str]
List of Email-ids to be notified about job progress.
phone This property is required. str
Phone number of the contact person.
mobile str
Mobile number of the contact person.
phone_extension str
Phone extension number of the contact person.
contactName This property is required. String
Contact name of the person.
emailList This property is required. List<String>
List of Email-ids to be notified about job progress.
phone This property is required. String
Phone number of the contact person.
mobile String
Mobile number of the contact person.
phoneExtension String
Phone extension number of the contact person.

DeviceDetailsResponse

ManagementResourceId This property is required. string
Management Resource Id
ManagementResourceTenantId This property is required. string
Management Resource Tenant ID
SerialNumber This property is required. string
device serial number
ManagementResourceId This property is required. string
Management Resource Id
ManagementResourceTenantId This property is required. string
Management Resource Tenant ID
SerialNumber This property is required. string
device serial number
managementResourceId This property is required. String
Management Resource Id
managementResourceTenantId This property is required. String
Management Resource Tenant ID
serialNumber This property is required. String
device serial number
managementResourceId This property is required. string
Management Resource Id
managementResourceTenantId This property is required. string
Management Resource Tenant ID
serialNumber This property is required. string
device serial number
management_resource_id This property is required. str
Management Resource Id
management_resource_tenant_id This property is required. str
Management Resource Tenant ID
serial_number This property is required. str
device serial number
managementResourceId This property is required. String
Management Resource Id
managementResourceTenantId This property is required. String
Management Resource Tenant ID
serialNumber This property is required. String
device serial number

DisplayInfoResponse

ConfigurationDisplayName This property is required. string
Configuration display name
ProductFamilyDisplayName This property is required. string
Product family display name
ConfigurationDisplayName This property is required. string
Configuration display name
ProductFamilyDisplayName This property is required. string
Product family display name
configurationDisplayName This property is required. String
Configuration display name
productFamilyDisplayName This property is required. String
Product family display name
configurationDisplayName This property is required. string
Configuration display name
productFamilyDisplayName This property is required. string
Product family display name
configuration_display_name This property is required. str
Configuration display name
product_family_display_name This property is required. str
Product family display name
configurationDisplayName This property is required. String
Configuration display name
productFamilyDisplayName This property is required. String
Product family display name

EncryptionPreferencesResponse

DoubleEncryptionStatus string
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
DoubleEncryptionStatus string
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
doubleEncryptionStatus String
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
doubleEncryptionStatus string
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
double_encryption_status str
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
doubleEncryptionStatus String
Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.

ErrorAdditionalInfoResponse

Info This property is required. object
The additional info.
Type This property is required. string
The additional info type.
Info This property is required. interface{}
The additional info.
Type This property is required. string
The additional info type.
info This property is required. Object
The additional info.
type This property is required. String
The additional info type.
info This property is required. any
The additional info.
type This property is required. string
The additional info type.
info This property is required. Any
The additional info.
type This property is required. str
The additional info type.
info This property is required. Any
The additional info.
type This property is required. String
The additional info type.

ErrorDetailResponse

AdditionalInfo This property is required. List<Pulumi.AzureNative.EdgeOrder.Inputs.ErrorAdditionalInfoResponse>
The error additional info.
Code This property is required. string
The error code.
Details This property is required. List<Pulumi.AzureNative.EdgeOrder.Inputs.ErrorDetailResponse>
The error details.
Message This property is required. string
The error message.
Target This property is required. string
The error target.
AdditionalInfo This property is required. []ErrorAdditionalInfoResponse
The error additional info.
Code This property is required. string
The error code.
Details This property is required. []ErrorDetailResponse
The error details.
Message This property is required. string
The error message.
Target This property is required. string
The error target.
additionalInfo This property is required. List<ErrorAdditionalInfoResponse>
The error additional info.
code This property is required. String
The error code.
details This property is required. List<ErrorDetailResponse>
The error details.
message This property is required. String
The error message.
target This property is required. String
The error target.
additionalInfo This property is required. ErrorAdditionalInfoResponse[]
The error additional info.
code This property is required. string
The error code.
details This property is required. ErrorDetailResponse[]
The error details.
message This property is required. string
The error message.
target This property is required. string
The error target.
additional_info This property is required. Sequence[ErrorAdditionalInfoResponse]
The error additional info.
code This property is required. str
The error code.
details This property is required. Sequence[ErrorDetailResponse]
The error details.
message This property is required. str
The error message.
target This property is required. str
The error target.
additionalInfo This property is required. List<Property Map>
The error additional info.
code This property is required. String
The error code.
details This property is required. List<Property Map>
The error details.
message This property is required. String
The error message.
target This property is required. String
The error target.

ForwardShippingDetailsResponse

CarrierDisplayName This property is required. string
Carrier Name for display purpose. Not to be used for any processing.
CarrierName This property is required. string
Name of the carrier.
TrackingId This property is required. string
TrackingId of the package
TrackingUrl This property is required. string
TrackingUrl of the package.
CarrierDisplayName This property is required. string
Carrier Name for display purpose. Not to be used for any processing.
CarrierName This property is required. string
Name of the carrier.
TrackingId This property is required. string
TrackingId of the package
TrackingUrl This property is required. string
TrackingUrl of the package.
carrierDisplayName This property is required. String
Carrier Name for display purpose. Not to be used for any processing.
carrierName This property is required. String
Name of the carrier.
trackingId This property is required. String
TrackingId of the package
trackingUrl This property is required. String
TrackingUrl of the package.
carrierDisplayName This property is required. string
Carrier Name for display purpose. Not to be used for any processing.
carrierName This property is required. string
Name of the carrier.
trackingId This property is required. string
TrackingId of the package
trackingUrl This property is required. string
TrackingUrl of the package.
carrier_display_name This property is required. str
Carrier Name for display purpose. Not to be used for any processing.
carrier_name This property is required. str
Name of the carrier.
tracking_id This property is required. str
TrackingId of the package
tracking_url This property is required. str
TrackingUrl of the package.
carrierDisplayName This property is required. String
Carrier Name for display purpose. Not to be used for any processing.
carrierName This property is required. String
Name of the carrier.
trackingId This property is required. String
TrackingId of the package
trackingUrl This property is required. String
TrackingUrl of the package.

HierarchyInformationResponse

ConfigurationName string
Represents configuration name that uniquely identifies configuration.
ProductFamilyName string
Represents product family name that uniquely identifies product family.
ProductLineName string
Represents product line name that uniquely identifies product line.
ProductName string
Represents product name that uniquely identifies product.
ConfigurationName string
Represents configuration name that uniquely identifies configuration.
ProductFamilyName string
Represents product family name that uniquely identifies product family.
ProductLineName string
Represents product line name that uniquely identifies product line.
ProductName string
Represents product name that uniquely identifies product.
configurationName String
Represents configuration name that uniquely identifies configuration.
productFamilyName String
Represents product family name that uniquely identifies product family.
productLineName String
Represents product line name that uniquely identifies product line.
productName String
Represents product name that uniquely identifies product.
configurationName string
Represents configuration name that uniquely identifies configuration.
productFamilyName string
Represents product family name that uniquely identifies product family.
productLineName string
Represents product line name that uniquely identifies product line.
productName string
Represents product name that uniquely identifies product.
configuration_name str
Represents configuration name that uniquely identifies configuration.
product_family_name str
Represents product family name that uniquely identifies product family.
product_line_name str
Represents product line name that uniquely identifies product line.
product_name str
Represents product name that uniquely identifies product.
configurationName String
Represents configuration name that uniquely identifies configuration.
productFamilyName String
Represents product family name that uniquely identifies product family.
productLineName String
Represents product line name that uniquely identifies product line.
productName String
Represents product name that uniquely identifies product.

ManagementResourcePreferencesResponse

PreferredManagementResourceId string
Customer preferred Management resource ARM ID
PreferredManagementResourceId string
Customer preferred Management resource ARM ID
preferredManagementResourceId String
Customer preferred Management resource ARM ID
preferredManagementResourceId string
Customer preferred Management resource ARM ID
preferred_management_resource_id str
Customer preferred Management resource ARM ID
preferredManagementResourceId String
Customer preferred Management resource ARM ID

NotificationPreferenceResponse

SendNotification This property is required. bool
Notification is required or not.
StageName This property is required. string
Name of the stage.
SendNotification This property is required. bool
Notification is required or not.
StageName This property is required. string
Name of the stage.
sendNotification This property is required. Boolean
Notification is required or not.
stageName This property is required. String
Name of the stage.
sendNotification This property is required. boolean
Notification is required or not.
stageName This property is required. string
Name of the stage.
send_notification This property is required. bool
Notification is required or not.
stage_name This property is required. str
Name of the stage.
sendNotification This property is required. Boolean
Notification is required or not.
stageName This property is required. String
Name of the stage.

OrderItemDetailsResponse

CancellationReason This property is required. string
Cancellation reason.
CancellationStatus This property is required. string
Describes whether the order item is cancellable or not.
CurrentStage This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.StageDetailsResponse
Current Order item Status
DeletionStatus This property is required. string
Describes whether the order item is deletable or not.
Error This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.ErrorDetailResponse
Top level error for the job.
ForwardShippingDetails This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.ForwardShippingDetailsResponse
Forward Package Shipping details
ManagementRpDetails This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.ResourceProviderDetailsResponse
Parent RP details - this returns only the first or default parent RP from the entire list
ManagementRpDetailsList This property is required. List<Pulumi.AzureNative.EdgeOrder.Inputs.ResourceProviderDetailsResponse>
List of parent RP details supported for configuration.
OrderItemStageHistory This property is required. List<Pulumi.AzureNative.EdgeOrder.Inputs.StageDetailsResponse>
Order item status history
OrderItemType This property is required. string
Order item type.
ProductDetails This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.ProductDetailsResponse
Unique identifier for configuration.
ReturnReason This property is required. string
Return reason.
ReturnStatus This property is required. string
Describes whether the order item is returnable or not.
ReverseShippingDetails This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.ReverseShippingDetailsResponse
Reverse Package Shipping details
NotificationEmailList List<string>
Additional notification email list
OrderItemMode string
Defines the mode of the Order item.
Preferences Pulumi.AzureNative.EdgeOrder.Inputs.PreferencesResponse
Customer notification Preferences
CancellationReason This property is required. string
Cancellation reason.
CancellationStatus This property is required. string
Describes whether the order item is cancellable or not.
CurrentStage This property is required. StageDetailsResponse
Current Order item Status
DeletionStatus This property is required. string
Describes whether the order item is deletable or not.
Error This property is required. ErrorDetailResponse
Top level error for the job.
ForwardShippingDetails This property is required. ForwardShippingDetailsResponse
Forward Package Shipping details
ManagementRpDetails This property is required. ResourceProviderDetailsResponse
Parent RP details - this returns only the first or default parent RP from the entire list
ManagementRpDetailsList This property is required. []ResourceProviderDetailsResponse
List of parent RP details supported for configuration.
OrderItemStageHistory This property is required. []StageDetailsResponse
Order item status history
OrderItemType This property is required. string
Order item type.
ProductDetails This property is required. ProductDetailsResponse
Unique identifier for configuration.
ReturnReason This property is required. string
Return reason.
ReturnStatus This property is required. string
Describes whether the order item is returnable or not.
ReverseShippingDetails This property is required. ReverseShippingDetailsResponse
Reverse Package Shipping details
NotificationEmailList []string
Additional notification email list
OrderItemMode string
Defines the mode of the Order item.
Preferences PreferencesResponse
Customer notification Preferences
cancellationReason This property is required. String
Cancellation reason.
cancellationStatus This property is required. String
Describes whether the order item is cancellable or not.
currentStage This property is required. StageDetailsResponse
Current Order item Status
deletionStatus This property is required. String
Describes whether the order item is deletable or not.
error This property is required. ErrorDetailResponse
Top level error for the job.
forwardShippingDetails This property is required. ForwardShippingDetailsResponse
Forward Package Shipping details
managementRpDetails This property is required. ResourceProviderDetailsResponse
Parent RP details - this returns only the first or default parent RP from the entire list
managementRpDetailsList This property is required. List<ResourceProviderDetailsResponse>
List of parent RP details supported for configuration.
orderItemStageHistory This property is required. List<StageDetailsResponse>
Order item status history
orderItemType This property is required. String
Order item type.
productDetails This property is required. ProductDetailsResponse
Unique identifier for configuration.
returnReason This property is required. String
Return reason.
returnStatus This property is required. String
Describes whether the order item is returnable or not.
reverseShippingDetails This property is required. ReverseShippingDetailsResponse
Reverse Package Shipping details
notificationEmailList List<String>
Additional notification email list
orderItemMode String
Defines the mode of the Order item.
preferences PreferencesResponse
Customer notification Preferences
cancellationReason This property is required. string
Cancellation reason.
cancellationStatus This property is required. string
Describes whether the order item is cancellable or not.
currentStage This property is required. StageDetailsResponse
Current Order item Status
deletionStatus This property is required. string
Describes whether the order item is deletable or not.
error This property is required. ErrorDetailResponse
Top level error for the job.
forwardShippingDetails This property is required. ForwardShippingDetailsResponse
Forward Package Shipping details
managementRpDetails This property is required. ResourceProviderDetailsResponse
Parent RP details - this returns only the first or default parent RP from the entire list
managementRpDetailsList This property is required. ResourceProviderDetailsResponse[]
List of parent RP details supported for configuration.
orderItemStageHistory This property is required. StageDetailsResponse[]
Order item status history
orderItemType This property is required. string
Order item type.
productDetails This property is required. ProductDetailsResponse
Unique identifier for configuration.
returnReason This property is required. string
Return reason.
returnStatus This property is required. string
Describes whether the order item is returnable or not.
reverseShippingDetails This property is required. ReverseShippingDetailsResponse
Reverse Package Shipping details
notificationEmailList string[]
Additional notification email list
orderItemMode string
Defines the mode of the Order item.
preferences PreferencesResponse
Customer notification Preferences
cancellation_reason This property is required. str
Cancellation reason.
cancellation_status This property is required. str
Describes whether the order item is cancellable or not.
current_stage This property is required. StageDetailsResponse
Current Order item Status
deletion_status This property is required. str
Describes whether the order item is deletable or not.
error This property is required. ErrorDetailResponse
Top level error for the job.
forward_shipping_details This property is required. ForwardShippingDetailsResponse
Forward Package Shipping details
management_rp_details This property is required. ResourceProviderDetailsResponse
Parent RP details - this returns only the first or default parent RP from the entire list
management_rp_details_list This property is required. Sequence[ResourceProviderDetailsResponse]
List of parent RP details supported for configuration.
order_item_stage_history This property is required. Sequence[StageDetailsResponse]
Order item status history
order_item_type This property is required. str
Order item type.
product_details This property is required. ProductDetailsResponse
Unique identifier for configuration.
return_reason This property is required. str
Return reason.
return_status This property is required. str
Describes whether the order item is returnable or not.
reverse_shipping_details This property is required. ReverseShippingDetailsResponse
Reverse Package Shipping details
notification_email_list Sequence[str]
Additional notification email list
order_item_mode str
Defines the mode of the Order item.
preferences PreferencesResponse
Customer notification Preferences
cancellationReason This property is required. String
Cancellation reason.
cancellationStatus This property is required. String
Describes whether the order item is cancellable or not.
currentStage This property is required. Property Map
Current Order item Status
deletionStatus This property is required. String
Describes whether the order item is deletable or not.
error This property is required. Property Map
Top level error for the job.
forwardShippingDetails This property is required. Property Map
Forward Package Shipping details
managementRpDetails This property is required. Property Map
Parent RP details - this returns only the first or default parent RP from the entire list
managementRpDetailsList This property is required. List<Property Map>
List of parent RP details supported for configuration.
orderItemStageHistory This property is required. List<Property Map>
Order item status history
orderItemType This property is required. String
Order item type.
productDetails This property is required. Property Map
Unique identifier for configuration.
returnReason This property is required. String
Return reason.
returnStatus This property is required. String
Describes whether the order item is returnable or not.
reverseShippingDetails This property is required. Property Map
Reverse Package Shipping details
notificationEmailList List<String>
Additional notification email list
orderItemMode String
Defines the mode of the Order item.
preferences Property Map
Customer notification Preferences

PreferencesResponse

EncryptionPreferences EncryptionPreferencesResponse
Preferences related to the Encryption.
ManagementResourcePreferences ManagementResourcePreferencesResponse
Preferences related to the Management resource.
NotificationPreferences []NotificationPreferenceResponse
Notification preferences.
TransportPreferences TransportPreferencesResponse
Preferences related to the shipment logistics of the order.
encryptionPreferences EncryptionPreferencesResponse
Preferences related to the Encryption.
managementResourcePreferences ManagementResourcePreferencesResponse
Preferences related to the Management resource.
notificationPreferences List<NotificationPreferenceResponse>
Notification preferences.
transportPreferences TransportPreferencesResponse
Preferences related to the shipment logistics of the order.
encryptionPreferences EncryptionPreferencesResponse
Preferences related to the Encryption.
managementResourcePreferences ManagementResourcePreferencesResponse
Preferences related to the Management resource.
notificationPreferences NotificationPreferenceResponse[]
Notification preferences.
transportPreferences TransportPreferencesResponse
Preferences related to the shipment logistics of the order.
encryption_preferences EncryptionPreferencesResponse
Preferences related to the Encryption.
management_resource_preferences ManagementResourcePreferencesResponse
Preferences related to the Management resource.
notification_preferences Sequence[NotificationPreferenceResponse]
Notification preferences.
transport_preferences TransportPreferencesResponse
Preferences related to the shipment logistics of the order.
encryptionPreferences Property Map
Preferences related to the Encryption.
managementResourcePreferences Property Map
Preferences related to the Management resource.
notificationPreferences List<Property Map>
Notification preferences.
transportPreferences Property Map
Preferences related to the shipment logistics of the order.

ProductDetailsResponse

Count This property is required. int
Quantity of the product
DeviceDetails This property is required. List<Pulumi.AzureNative.EdgeOrder.Inputs.DeviceDetailsResponse>
list of device details
HierarchyInformation This property is required. Pulumi.AzureNative.EdgeOrder.Inputs.HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the product
ProductDoubleEncryptionStatus This property is required. string
Double encryption status of the configuration. Read-only field.
ChildConfigurationDeviceDetails List<Pulumi.AzureNative.EdgeOrder.Inputs.ConfigurationDeviceDetailsResponse>
Details of all child configurations that are part of the order item.
DisplayInfo Pulumi.AzureNative.EdgeOrder.Inputs.DisplayInfoResponse
Display details of the product
IdentificationType string
Identification type of the configuration.
OptInAdditionalConfigurations List<Pulumi.AzureNative.EdgeOrder.Inputs.AdditionalConfigurationResponse>
List of additional configurations customer wants in the order item apart from the ones included in the base configuration.
ParentDeviceDetails Pulumi.AzureNative.EdgeOrder.Inputs.DeviceDetailsResponse
Device details of the parent configuration.
Count This property is required. int
Quantity of the product
DeviceDetails This property is required. []DeviceDetailsResponse
list of device details
HierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the product
ProductDoubleEncryptionStatus This property is required. string
Double encryption status of the configuration. Read-only field.
ChildConfigurationDeviceDetails []ConfigurationDeviceDetailsResponse
Details of all child configurations that are part of the order item.
DisplayInfo DisplayInfoResponse
Display details of the product
IdentificationType string
Identification type of the configuration.
OptInAdditionalConfigurations []AdditionalConfigurationResponse
List of additional configurations customer wants in the order item apart from the ones included in the base configuration.
ParentDeviceDetails DeviceDetailsResponse
Device details of the parent configuration.
count This property is required. Integer
Quantity of the product
deviceDetails This property is required. List<DeviceDetailsResponse>
list of device details
hierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the product
productDoubleEncryptionStatus This property is required. String
Double encryption status of the configuration. Read-only field.
childConfigurationDeviceDetails List<ConfigurationDeviceDetailsResponse>
Details of all child configurations that are part of the order item.
displayInfo DisplayInfoResponse
Display details of the product
identificationType String
Identification type of the configuration.
optInAdditionalConfigurations List<AdditionalConfigurationResponse>
List of additional configurations customer wants in the order item apart from the ones included in the base configuration.
parentDeviceDetails DeviceDetailsResponse
Device details of the parent configuration.
count This property is required. number
Quantity of the product
deviceDetails This property is required. DeviceDetailsResponse[]
list of device details
hierarchyInformation This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the product
productDoubleEncryptionStatus This property is required. string
Double encryption status of the configuration. Read-only field.
childConfigurationDeviceDetails ConfigurationDeviceDetailsResponse[]
Details of all child configurations that are part of the order item.
displayInfo DisplayInfoResponse
Display details of the product
identificationType string
Identification type of the configuration.
optInAdditionalConfigurations AdditionalConfigurationResponse[]
List of additional configurations customer wants in the order item apart from the ones included in the base configuration.
parentDeviceDetails DeviceDetailsResponse
Device details of the parent configuration.
count This property is required. int
Quantity of the product
device_details This property is required. Sequence[DeviceDetailsResponse]
list of device details
hierarchy_information This property is required. HierarchyInformationResponse
Hierarchy of the product which uniquely identifies the product
product_double_encryption_status This property is required. str
Double encryption status of the configuration. Read-only field.
child_configuration_device_details Sequence[ConfigurationDeviceDetailsResponse]
Details of all child configurations that are part of the order item.
display_info DisplayInfoResponse
Display details of the product
identification_type str
Identification type of the configuration.
opt_in_additional_configurations Sequence[AdditionalConfigurationResponse]
List of additional configurations customer wants in the order item apart from the ones included in the base configuration.
parent_device_details DeviceDetailsResponse
Device details of the parent configuration.
count This property is required. Number
Quantity of the product
deviceDetails This property is required. List<Property Map>
list of device details
hierarchyInformation This property is required. Property Map
Hierarchy of the product which uniquely identifies the product
productDoubleEncryptionStatus This property is required. String
Double encryption status of the configuration. Read-only field.
childConfigurationDeviceDetails List<Property Map>
Details of all child configurations that are part of the order item.
displayInfo Property Map
Display details of the product
identificationType String
Identification type of the configuration.
optInAdditionalConfigurations List<Property Map>
List of additional configurations customer wants in the order item apart from the ones included in the base configuration.
parentDeviceDetails Property Map
Device details of the parent configuration.

ResourceProviderDetailsResponse

ResourceProviderNamespace This property is required. string
Resource provider namespace.
ResourceProviderNamespace This property is required. string
Resource provider namespace.
resourceProviderNamespace This property is required. String
Resource provider namespace.
resourceProviderNamespace This property is required. string
Resource provider namespace.
resource_provider_namespace This property is required. str
Resource provider namespace.
resourceProviderNamespace This property is required. String
Resource provider namespace.

ReverseShippingDetailsResponse

CarrierDisplayName This property is required. string
Carrier Name for display purpose. Not to be used for any processing.
CarrierName This property is required. string
Name of the carrier.
SasKeyForLabel This property is required. string
SAS key to download the reverse shipment label of the package.
TrackingId This property is required. string
TrackingId of the package
TrackingUrl This property is required. string
TrackingUrl of the package.
CarrierDisplayName This property is required. string
Carrier Name for display purpose. Not to be used for any processing.
CarrierName This property is required. string
Name of the carrier.
SasKeyForLabel This property is required. string
SAS key to download the reverse shipment label of the package.
TrackingId This property is required. string
TrackingId of the package
TrackingUrl This property is required. string
TrackingUrl of the package.
carrierDisplayName This property is required. String
Carrier Name for display purpose. Not to be used for any processing.
carrierName This property is required. String
Name of the carrier.
sasKeyForLabel This property is required. String
SAS key to download the reverse shipment label of the package.
trackingId This property is required. String
TrackingId of the package
trackingUrl This property is required. String
TrackingUrl of the package.
carrierDisplayName This property is required. string
Carrier Name for display purpose. Not to be used for any processing.
carrierName This property is required. string
Name of the carrier.
sasKeyForLabel This property is required. string
SAS key to download the reverse shipment label of the package.
trackingId This property is required. string
TrackingId of the package
trackingUrl This property is required. string
TrackingUrl of the package.
carrier_display_name This property is required. str
Carrier Name for display purpose. Not to be used for any processing.
carrier_name This property is required. str
Name of the carrier.
sas_key_for_label This property is required. str
SAS key to download the reverse shipment label of the package.
tracking_id This property is required. str
TrackingId of the package
tracking_url This property is required. str
TrackingUrl of the package.
carrierDisplayName This property is required. String
Carrier Name for display purpose. Not to be used for any processing.
carrierName This property is required. String
Name of the carrier.
sasKeyForLabel This property is required. String
SAS key to download the reverse shipment label of the package.
trackingId This property is required. String
TrackingId of the package
trackingUrl This property is required. String
TrackingUrl of the package.

ShippingAddressResponse

Country This property is required. string
Name of the Country.
StreetAddress1 This property is required. string
Street Address line 1.
AddressType string
Type of address.
City string
Name of the City.
CompanyName string
Name of the company.
PostalCode string
Postal code.
StateOrProvince string
Name of the State or Province.
StreetAddress2 string
Street Address line 2.
StreetAddress3 string
Street Address line 3.
ZipExtendedCode string
Extended Zip Code.
Country This property is required. string
Name of the Country.
StreetAddress1 This property is required. string
Street Address line 1.
AddressType string
Type of address.
City string
Name of the City.
CompanyName string
Name of the company.
PostalCode string
Postal code.
StateOrProvince string
Name of the State or Province.
StreetAddress2 string
Street Address line 2.
StreetAddress3 string
Street Address line 3.
ZipExtendedCode string
Extended Zip Code.
country This property is required. String
Name of the Country.
streetAddress1 This property is required. String
Street Address line 1.
addressType String
Type of address.
city String
Name of the City.
companyName String
Name of the company.
postalCode String
Postal code.
stateOrProvince String
Name of the State or Province.
streetAddress2 String
Street Address line 2.
streetAddress3 String
Street Address line 3.
zipExtendedCode String
Extended Zip Code.
country This property is required. string
Name of the Country.
streetAddress1 This property is required. string
Street Address line 1.
addressType string
Type of address.
city string
Name of the City.
companyName string
Name of the company.
postalCode string
Postal code.
stateOrProvince string
Name of the State or Province.
streetAddress2 string
Street Address line 2.
streetAddress3 string
Street Address line 3.
zipExtendedCode string
Extended Zip Code.
country This property is required. str
Name of the Country.
street_address1 This property is required. str
Street Address line 1.
address_type str
Type of address.
city str
Name of the City.
company_name str
Name of the company.
postal_code str
Postal code.
state_or_province str
Name of the State or Province.
street_address2 str
Street Address line 2.
street_address3 str
Street Address line 3.
zip_extended_code str
Extended Zip Code.
country This property is required. String
Name of the Country.
streetAddress1 This property is required. String
Street Address line 1.
addressType String
Type of address.
city String
Name of the City.
companyName String
Name of the company.
postalCode String
Postal code.
stateOrProvince String
Name of the State or Province.
streetAddress2 String
Street Address line 2.
streetAddress3 String
Street Address line 3.
zipExtendedCode String
Extended Zip Code.

StageDetailsResponse

DisplayName This property is required. string
Display name of the resource stage.
StageName This property is required. string
Stage name
StageStatus This property is required. string
Stage status.
StartTime This property is required. string
Stage start time
DisplayName This property is required. string
Display name of the resource stage.
StageName This property is required. string
Stage name
StageStatus This property is required. string
Stage status.
StartTime This property is required. string
Stage start time
displayName This property is required. String
Display name of the resource stage.
stageName This property is required. String
Stage name
stageStatus This property is required. String
Stage status.
startTime This property is required. String
Stage start time
displayName This property is required. string
Display name of the resource stage.
stageName This property is required. string
Stage name
stageStatus This property is required. string
Stage status.
startTime This property is required. string
Stage start time
display_name This property is required. str
Display name of the resource stage.
stage_name This property is required. str
Stage name
stage_status This property is required. str
Stage status.
start_time This property is required. str
Stage start time
displayName This property is required. String
Display name of the resource stage.
stageName This property is required. String
Stage name
stageStatus This property is required. String
Stage status.
startTime This property is required. String
Stage start time

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

TransportPreferencesResponse

PreferredShipmentType This property is required. string
Indicates Shipment Logistics type that the customer preferred.
PreferredShipmentType This property is required. string
Indicates Shipment Logistics type that the customer preferred.
preferredShipmentType This property is required. String
Indicates Shipment Logistics type that the customer preferred.
preferredShipmentType This property is required. string
Indicates Shipment Logistics type that the customer preferred.
preferred_shipment_type This property is required. str
Indicates Shipment Logistics type that the customer preferred.
preferredShipmentType This property is required. String
Indicates Shipment Logistics type that the customer preferred.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi