Orders - List By Subscription

Elencare gli ordini a livello di sottoscrizione.

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

Parametri dell'URI

Name In Required Type Description
subscriptionId
path True
  • string

ID della sottoscrizione di destinazione.

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

Name Type Description
200 OK

Elenco degli ordini disponibili nella sottoscrizione.

Other Status Codes

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

Name Description
user_impersonation rappresentare l'account utente

Esempio

ListOrderAtSubscriptionLevel

Sample Request

GET https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/orders?api-version=2022-05-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "orderItemIds": [
          "/subscriptions/YourSubscriptionId/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/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName1",
      "type": "Microsoft.EdgeOrder/orders"
    },
    {
      "properties": {
        "orderItemIds": [
          "/subscriptions/YourSubscriptionId/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/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName2",
      "type": "Microsoft.EdgeOrder/orders"
    }
  ]
}

Definizioni

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 fase.

StageStatus

Stato fase.

systemData

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

createdByType

Tipo di identità che ha creato la risorsa.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Name Type Description
info
  • object

Informazioni aggiuntive.

type
  • string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Name Type Description
additionalInfo

Informazioni aggiuntive sull'errore.

code
  • string

Codice di errore.

details

Dettagli dell'errore.

message
  • string

Messaggio di errore.

target
  • string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Name Type Description
error

Oggetto error.

OrderMode

Definisce la modalità dell'elemento Order.

Name Type Description
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.

Name Type Description
id
  • string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

nome della risorsa.

properties.currentStage

Stato corrente dell'ordine

properties.orderItemIds
  • string[]

Elenco degli ID ARM dell'elemento dell'ordine che fanno parte di un ordine.

properties.orderMode

Modalità ordine.

properties.orderStageHistory

Cronologia dello stato dell'ordine.

systemData

Rappresenta la creazione e l'ora di aggiornamento delle risorse.

type
  • string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

OrderResourceList

Elenco degli ordini.

Name Type Description
nextLink
  • string

Collegamento per il set successivo di risorse dell'ordine.

value

Elenco delle risorse dell'ordine.

StageDetails

Dettagli della fase risorsa.

Name Type Description
displayName
  • string

Nome visualizzato della fase della risorsa.

stageName

Nome fase.

stageStatus

Stato fase.

startTime
  • string

Ora di inizio fase.

StageName

Nome fase.

Name Type Description
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.

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.

Name Type Description
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.

Name Type Description
createdAt
  • string

Timestamp della creazione di risorse (UTC).

createdBy
  • string

Identità che ha creato la risorsa.

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

Tipo di identità che ha modificato l'ultima risorsa.