1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. getOrder
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.34.0 published on Thursday, Mar 28, 2024 by Pulumi

azure-native.databoxedge.getOrder

Explore with Pulumi AI

azure-native logo
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.34.0 published on Thursday, Mar 28, 2024 by Pulumi

    The order details. Azure REST API version: 2022-03-01.

    Other available API versions: 2020-05-01-preview, 2022-04-01-preview, 2023-01-01-preview, 2023-07-01, 2023-12-01.

    Using getOrder

    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 getOrder(args: GetOrderArgs, opts?: InvokeOptions): Promise<GetOrderResult>
    function getOrderOutput(args: GetOrderOutputArgs, opts?: InvokeOptions): Output<GetOrderResult>
    def get_order(device_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetOrderResult
    def get_order_output(device_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetOrderResult]
    func LookupOrder(ctx *Context, args *LookupOrderArgs, opts ...InvokeOption) (*LookupOrderResult, error)
    func LookupOrderOutput(ctx *Context, args *LookupOrderOutputArgs, opts ...InvokeOption) LookupOrderResultOutput

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

    public static class GetOrder 
    {
        public static Task<GetOrderResult> InvokeAsync(GetOrderArgs args, InvokeOptions? opts = null)
        public static Output<GetOrderResult> Invoke(GetOrderInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrderResult> getOrder(GetOrderArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:databoxedge:getOrder
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DeviceName string
    The device name.
    ResourceGroupName string
    The resource group name.
    DeviceName string
    The device name.
    ResourceGroupName string
    The resource group name.
    deviceName String
    The device name.
    resourceGroupName String
    The resource group name.
    deviceName string
    The device name.
    resourceGroupName string
    The resource group name.
    device_name str
    The device name.
    resource_group_name str
    The resource group name.
    deviceName String
    The device name.
    resourceGroupName String
    The resource group name.

    getOrder Result

    The following output properties are available:

    ContactInformation Pulumi.AzureNative.DataBoxEdge.Outputs.ContactDetailsResponse
    The contact details.
    CurrentStatus Pulumi.AzureNative.DataBoxEdge.Outputs.OrderStatusResponse
    Current status of the order.
    DeliveryTrackingInfo List<Pulumi.AzureNative.DataBoxEdge.Outputs.TrackingInfoResponse>
    Tracking information for the package delivered to the customer whether it has an original or a replacement device.
    Id string
    The path ID that uniquely identifies the object.
    Kind string
    It specify the order api version.
    Name string
    The object name.
    OrderHistory List<Pulumi.AzureNative.DataBoxEdge.Outputs.OrderStatusResponse>
    List of status changes in the order.
    OrderId string
    It specify the order resource id.
    ReturnTrackingInfo List<Pulumi.AzureNative.DataBoxEdge.Outputs.TrackingInfoResponse>
    Tracking information for the package returned from the customer whether it has an original or a replacement device.
    SerialNumber string
    Serial number of the device.
    SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of Order
    Type string
    The hierarchical type of the object.
    ShipmentType string
    ShipmentType of the order
    ShippingAddress Pulumi.AzureNative.DataBoxEdge.Outputs.AddressResponse
    The shipping address.
    ContactInformation ContactDetailsResponse
    The contact details.
    CurrentStatus OrderStatusResponse
    Current status of the order.
    DeliveryTrackingInfo []TrackingInfoResponse
    Tracking information for the package delivered to the customer whether it has an original or a replacement device.
    Id string
    The path ID that uniquely identifies the object.
    Kind string
    It specify the order api version.
    Name string
    The object name.
    OrderHistory []OrderStatusResponse
    List of status changes in the order.
    OrderId string
    It specify the order resource id.
    ReturnTrackingInfo []TrackingInfoResponse
    Tracking information for the package returned from the customer whether it has an original or a replacement device.
    SerialNumber string
    Serial number of the device.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of Order
    Type string
    The hierarchical type of the object.
    ShipmentType string
    ShipmentType of the order
    ShippingAddress AddressResponse
    The shipping address.
    contactInformation ContactDetailsResponse
    The contact details.
    currentStatus OrderStatusResponse
    Current status of the order.
    deliveryTrackingInfo List<TrackingInfoResponse>
    Tracking information for the package delivered to the customer whether it has an original or a replacement device.
    id String
    The path ID that uniquely identifies the object.
    kind String
    It specify the order api version.
    name String
    The object name.
    orderHistory List<OrderStatusResponse>
    List of status changes in the order.
    orderId String
    It specify the order resource id.
    returnTrackingInfo List<TrackingInfoResponse>
    Tracking information for the package returned from the customer whether it has an original or a replacement device.
    serialNumber String
    Serial number of the device.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of Order
    type String
    The hierarchical type of the object.
    shipmentType String
    ShipmentType of the order
    shippingAddress AddressResponse
    The shipping address.
    contactInformation ContactDetailsResponse
    The contact details.
    currentStatus OrderStatusResponse
    Current status of the order.
    deliveryTrackingInfo TrackingInfoResponse[]
    Tracking information for the package delivered to the customer whether it has an original or a replacement device.
    id string
    The path ID that uniquely identifies the object.
    kind string
    It specify the order api version.
    name string
    The object name.
    orderHistory OrderStatusResponse[]
    List of status changes in the order.
    orderId string
    It specify the order resource id.
    returnTrackingInfo TrackingInfoResponse[]
    Tracking information for the package returned from the customer whether it has an original or a replacement device.
    serialNumber string
    Serial number of the device.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of Order
    type string
    The hierarchical type of the object.
    shipmentType string
    ShipmentType of the order
    shippingAddress AddressResponse
    The shipping address.
    contact_information ContactDetailsResponse
    The contact details.
    current_status OrderStatusResponse
    Current status of the order.
    delivery_tracking_info Sequence[TrackingInfoResponse]
    Tracking information for the package delivered to the customer whether it has an original or a replacement device.
    id str
    The path ID that uniquely identifies the object.
    kind str
    It specify the order api version.
    name str
    The object name.
    order_history Sequence[OrderStatusResponse]
    List of status changes in the order.
    order_id str
    It specify the order resource id.
    return_tracking_info Sequence[TrackingInfoResponse]
    Tracking information for the package returned from the customer whether it has an original or a replacement device.
    serial_number str
    Serial number of the device.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of Order
    type str
    The hierarchical type of the object.
    shipment_type str
    ShipmentType of the order
    shipping_address AddressResponse
    The shipping address.
    contactInformation Property Map
    The contact details.
    currentStatus Property Map
    Current status of the order.
    deliveryTrackingInfo List<Property Map>
    Tracking information for the package delivered to the customer whether it has an original or a replacement device.
    id String
    The path ID that uniquely identifies the object.
    kind String
    It specify the order api version.
    name String
    The object name.
    orderHistory List<Property Map>
    List of status changes in the order.
    orderId String
    It specify the order resource id.
    returnTrackingInfo List<Property Map>
    Tracking information for the package returned from the customer whether it has an original or a replacement device.
    serialNumber String
    Serial number of the device.
    systemData Property Map
    Metadata pertaining to creation and last modification of Order
    type String
    The hierarchical type of the object.
    shipmentType String
    ShipmentType of the order
    shippingAddress Property Map
    The shipping address.

    Supporting Types

    AddressResponse

    Country string
    The country name.
    AddressLine1 string
    The address line1.
    AddressLine2 string
    The address line2.
    AddressLine3 string
    The address line3.
    City string
    The city name.
    PostalCode string
    The postal code.
    State string
    The state name.
    Country string
    The country name.
    AddressLine1 string
    The address line1.
    AddressLine2 string
    The address line2.
    AddressLine3 string
    The address line3.
    City string
    The city name.
    PostalCode string
    The postal code.
    State string
    The state name.
    country String
    The country name.
    addressLine1 String
    The address line1.
    addressLine2 String
    The address line2.
    addressLine3 String
    The address line3.
    city String
    The city name.
    postalCode String
    The postal code.
    state String
    The state name.
    country string
    The country name.
    addressLine1 string
    The address line1.
    addressLine2 string
    The address line2.
    addressLine3 string
    The address line3.
    city string
    The city name.
    postalCode string
    The postal code.
    state string
    The state name.
    country str
    The country name.
    address_line1 str
    The address line1.
    address_line2 str
    The address line2.
    address_line3 str
    The address line3.
    city str
    The city name.
    postal_code str
    The postal code.
    state str
    The state name.
    country String
    The country name.
    addressLine1 String
    The address line1.
    addressLine2 String
    The address line2.
    addressLine3 String
    The address line3.
    city String
    The city name.
    postalCode String
    The postal code.
    state String
    The state name.

    ContactDetailsResponse

    CompanyName string
    The name of the company.
    ContactPerson string
    The contact person name.
    EmailList List<string>
    The email list.
    Phone string
    The phone number.
    CompanyName string
    The name of the company.
    ContactPerson string
    The contact person name.
    EmailList []string
    The email list.
    Phone string
    The phone number.
    companyName String
    The name of the company.
    contactPerson String
    The contact person name.
    emailList List<String>
    The email list.
    phone String
    The phone number.
    companyName string
    The name of the company.
    contactPerson string
    The contact person name.
    emailList string[]
    The email list.
    phone string
    The phone number.
    company_name str
    The name of the company.
    contact_person str
    The contact person name.
    email_list Sequence[str]
    The email list.
    phone str
    The phone number.
    companyName String
    The name of the company.
    contactPerson String
    The contact person name.
    emailList List<String>
    The email list.
    phone String
    The phone number.

    OrderStatusResponse

    AdditionalOrderDetails Dictionary<string, string>
    Dictionary to hold generic information which is not stored by the already existing properties
    Status string
    Status of the order as per the allowed status types.
    TrackingInformation Pulumi.AzureNative.DataBoxEdge.Inputs.TrackingInfoResponse
    Tracking information related to the state in the ordering flow
    UpdateDateTime string
    Time of status update.
    Comments string
    Comments related to this status change.
    AdditionalOrderDetails map[string]string
    Dictionary to hold generic information which is not stored by the already existing properties
    Status string
    Status of the order as per the allowed status types.
    TrackingInformation TrackingInfoResponse
    Tracking information related to the state in the ordering flow
    UpdateDateTime string
    Time of status update.
    Comments string
    Comments related to this status change.
    additionalOrderDetails Map<String,String>
    Dictionary to hold generic information which is not stored by the already existing properties
    status String
    Status of the order as per the allowed status types.
    trackingInformation TrackingInfoResponse
    Tracking information related to the state in the ordering flow
    updateDateTime String
    Time of status update.
    comments String
    Comments related to this status change.
    additionalOrderDetails {[key: string]: string}
    Dictionary to hold generic information which is not stored by the already existing properties
    status string
    Status of the order as per the allowed status types.
    trackingInformation TrackingInfoResponse
    Tracking information related to the state in the ordering flow
    updateDateTime string
    Time of status update.
    comments string
    Comments related to this status change.
    additional_order_details Mapping[str, str]
    Dictionary to hold generic information which is not stored by the already existing properties
    status str
    Status of the order as per the allowed status types.
    tracking_information TrackingInfoResponse
    Tracking information related to the state in the ordering flow
    update_date_time str
    Time of status update.
    comments str
    Comments related to this status change.
    additionalOrderDetails Map<String>
    Dictionary to hold generic information which is not stored by the already existing properties
    status String
    Status of the order as per the allowed status types.
    trackingInformation Property Map
    Tracking information related to the state in the ordering flow
    updateDateTime String
    Time of status update.
    comments String
    Comments related to this status change.

    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.

    TrackingInfoResponse

    CarrierName string
    Name of the carrier used in the delivery.
    SerialNumber string
    Serial number of the device being tracked.
    TrackingId string
    Tracking ID of the shipment.
    TrackingUrl string
    Tracking URL of the shipment.
    CarrierName string
    Name of the carrier used in the delivery.
    SerialNumber string
    Serial number of the device being tracked.
    TrackingId string
    Tracking ID of the shipment.
    TrackingUrl string
    Tracking URL of the shipment.
    carrierName String
    Name of the carrier used in the delivery.
    serialNumber String
    Serial number of the device being tracked.
    trackingId String
    Tracking ID of the shipment.
    trackingUrl String
    Tracking URL of the shipment.
    carrierName string
    Name of the carrier used in the delivery.
    serialNumber string
    Serial number of the device being tracked.
    trackingId string
    Tracking ID of the shipment.
    trackingUrl string
    Tracking URL of the shipment.
    carrier_name str
    Name of the carrier used in the delivery.
    serial_number str
    Serial number of the device being tracked.
    tracking_id str
    Tracking ID of the shipment.
    tracking_url str
    Tracking URL of the shipment.
    carrierName String
    Name of the carrier used in the delivery.
    serialNumber String
    Serial number of the device being tracked.
    trackingId String
    Tracking ID of the shipment.
    trackingUrl String
    Tracking URL of the shipment.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.34.0 published on Thursday, Mar 28, 2024 by Pulumi