Orders - List By Subscription

Referencia

Service:: Edge Hardware Center

API Version:: 2024-02-01

Enumera los pedidos en el nivel de suscripción.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders?api-version=2024-02-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders?api-version=2024-02-01&$skipToken={$skipToken}&$top={$top}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string	Versión de API que se usará para la operación.
$skipToken	query		string	$skipToken se admite en Obtener lista de pedidos, que proporciona la página siguiente en la lista de pedidos.
$top	query		integer int32	$top se admite en la captura de la lista de recursos. $top=10 significa que los primeros 10 elementos de la lista se devolverán al llamador de la API.

Respuestas

Nombre	Tipo	Description
200 OK	OrderResourceList	Lista de pedidos disponibles en la suscripción.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ListOrderAtSubscriptionLevel

Sample Request

HTTP

GET https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/orders?api-version=2024-02-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "orderItemIds": [
          "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1"
        ],
        "currentStage": {
          "stageStatus": "Succeeded",
          "stageName": "Placed",
          "startTime": "2022-03-04T10:55:46.9437439+05:30"
        },
        "orderStageHistory": [
          {
            "stageStatus": "Succeeded",
            "stageName": "Placed",
            "startTime": "2022-03-04T10:55:46.9437439+05:30"
          },
          {
            "stageStatus": "None",
            "stageName": "InReview"
          }
        ]
      },
      "systemData": {
        "createdAt": "0001-01-01T05:30:00+05:30",
        "lastModifiedAt": "0001-01-01T05:30:00+05:30"
      },
      "name": "TestOrderItemName1",
      "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1",
      "type": "Microsoft.EdgeOrder/orders"
    },
    {
      "properties": {
        "orderItemIds": [
          "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName2"
        ],
        "currentStage": {
          "stageStatus": "InProgress",
          "stageName": "Placed",
          "startTime": "2022-03-04T10:58:46.5241979+05:30"
        },
        "orderStageHistory": [
          {
            "stageStatus": "None",
            "stageName": "Placed"
          },
          {
            "stageStatus": "None",
            "stageName": "InReview"
          }
        ]
      },
      "systemData": {
        "createdAt": "0001-01-01T05:30:00+05:30",
        "lastModifiedAt": "0001-01-01T05:30:00+05:30"
      },
      "name": "TestOrderItemName2",
      "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2",
      "type": "Microsoft.EdgeOrder/orders"
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
OrderMode	Define el modo del elemento Order.
OrderResource	Especifica las propiedades o parámetros de un pedido. Order es una agrupación de uno o varios elementos de pedido.
OrderResourceList	Lista de pedidos.
StageDetails	Detalles de la fase de recursos.
StageName	Nombre de fase.
StageStatus	Estado de fase.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

OrderMode

Define el modo del elemento Order.

Nombre	Tipo	Description
Default	string	Modo de pedido predeterminado.
DoNotFulfill	string	Modo en el que no se cumplirá la Orden.

OrderResource

Especifica las propiedades o parámetros de un pedido. Order es una agrupación de uno o varios elementos de pedido.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso.
properties.currentStage	StageDetails	Estado actual del pedido.
properties.orderItemIds	string[]	Lista de identificadores arm de elemento de pedido que forman parte de un pedido.
properties.orderMode	OrderMode	Modo de pedido.
properties.orderStageHistory	StageDetails[]	Historial de estado del pedido.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

OrderResourceList

Lista de pedidos.

Nombre	Tipo	Description
nextLink	string	Vínculo para el siguiente conjunto de recursos de pedido.
value	OrderResource[]	Lista de recursos de pedido.

StageDetails

Detalles de la fase de recursos.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la fase de recursos.
stageName	StageName	Nombre de fase.
stageStatus	StageStatus	Estado de fase.
startTime	string	Hora de inicio de la fase.

StageName

Nombre de fase.

Nombre	Tipo	Description
Cancelled	string	Se ha cancelado el pedido.
Confirmed	string	Se confirma el pedido.
Delivered	string	El pedido se entrega al cliente.
InReview	string	El pedido está actualmente en modo borrador y todavía se puede cancelar.
InUse	string	El pedido está en uso en el sitio del cliente.
Placed	string	Actualmente en modo borrador y todavía se puede cancelar.
ReadyToSetup	string	El pedido está listo para conectarse a la nube.
ReadyToShip	string	El pedido está listo para enviarse.
ReturnCompleted	string	La devolución ya se ha completado.
ReturnInitiated	string	El cliente ha iniciado la devolución.
ReturnPickedUp	string	El pedido está en tránsito desde el cliente a Microsoft.
ReturnedToMicrosoft	string	El pedido se ha recibido de vuelta a Microsoft.
Shipped	string	El pedido está en tránsito al cliente.

StageStatus

Estado de fase.

Nombre	Tipo	Description
Cancelled	string	Se ha cancelado la fase.
Cancelling	string	La fase se cancela.
Failed	string	Error en la fase.
InProgress	string	La fase está en curso.
None	string	Todavía no hay ningún estado disponible.
Succeeded	string	La fase se ha realizado correctamente.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.