Orders - List By Subscription

Riferimento

Service:: Edge Hardware Center

API Version:: 2024-02-01

Elencare gli ordini a livello di sottoscrizione.

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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$skipToken	query		string	$skipToken è supportato in Recupera elenco di ordini, che fornisce la pagina successiva nell'elenco degli ordini.
$top	query		integer int32	$top è supportato nel recupero dell'elenco di risorse. $top=10 significa che i primi 10 elementi dell'elenco verranno restituiti al chiamante API.

Risposte

Nome	Tipo	Descrizione
200 OK	OrderResourceList	Elenco degli ordini disponibili nella sottoscrizione.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo dell'errore dell'operazione.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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"
    }
  ]
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
OrderMode	Definisce la modalità dell'elemento Order.
OrderResource	Specifica le proprietà o i parametri per un ordine. L'ordine è un raggruppamento di uno o più elementi di ordine.
OrderResourceList	Elenco degli ordini.
StageDetails	Dettagli della fase risorsa.
StageName	Nome della fase.
StageStatus	Stato fase.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

OrderMode

Definisce la modalità dell'elemento Order.

Nome	Tipo	Descrizione
Default	string	Modalità ordine predefinito.
DoNotFulfill	string	Modalità in cui l'ordine non verrà soddisfatto.

OrderResource

Specifica le proprietà o i parametri per un ordine. L'ordine è un raggruppamento di uno o più elementi di ordine.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	nome della risorsa.
properties.currentStage	StageDetails	Stato corrente dell'ordine
properties.orderItemIds	string[]	Elenco degli ID ARM dell'elemento dell'ordine che fanno parte di un ordine.
properties.orderMode	OrderMode	Modalità ordine.
properties.orderStageHistory	StageDetails[]	Cronologia dello stato dell'ordine.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createBy e modificateBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

OrderResourceList

Elenco degli ordini.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per il set successivo di risorse dell'ordine.
value	OrderResource[]	Elenco delle risorse dell'ordine.

StageDetails

Dettagli della fase risorsa.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato della fase della risorsa.
stageName	StageName	Nome della fase.
stageStatus	StageStatus	Stato fase.
startTime	string	Ora di inizio fase.

StageName

Nome della fase.

Nome	Tipo	Descrizione
Cancelled	string	L'ordine è stato annullato.
Confirmed	string	L'ordine viene confermato.
Delivered	string	L'ordine viene recapitato al cliente.
InReview	string	L'ordine è attualmente in modalità bozza e può comunque essere annullato.
InUse	string	L'ordine è in uso nel sito del cliente.
Placed	string	Attualmente in modalità bozza e può comunque essere annullato.
ReadyToSetup	string	L'ordine è pronto per la connessione al cloud.
ReadyToShip	string	L'ordine è pronto per la spedizione.
ReturnCompleted	string	Il ritorno è stato completato.
ReturnInitiated	string	La restituzione è stata avviata dal cliente.
ReturnPickedUp	string	L'ordine è in transito dal cliente a Microsoft.
ReturnedToMicrosoft	string	L'ordine è stato ricevuto nuovamente a Microsoft.
Shipped	string	L'ordine è in transito al cliente.

StageStatus

Stato fase.

Nome	Tipo	Descrizione
Cancelled	string	La fase è stata annullata.
Cancelling	string	La fase viene annullata.
Failed	string	La fase non è riuscita.
InProgress	string	La fase è in corso.
None	string	Non è ancora disponibile alcun stato.
Succeeded	string	La fase ha avuto esito positivo.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.