Orders - List By Subscription

Odwołanie

Service:: Edge Hardware Center

API Version:: 2024-02-01

Wyświetlanie listy zamówień na poziomie subskrypcji.

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
$skipToken	query		string	$skipToken jest obsługiwany na stronie Pobieranie listy zamówień, która udostępnia następną stronę na liście zamówień.
$top	query		integer int32	$top jest obsługiwana podczas pobierania listy zasobów. $top=10 oznacza, że pierwsze 10 elementów na liście zostanie zwróconych do wywołującego interfejs API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OrderResourceList	Lista zamówień dostępnych w ramach subskrypcji.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca przyczynę niepowodzenia operacji.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
OrderMode	Definiuje tryb elementu Order.
OrderResource	Określa właściwości lub parametry dla zamówienia. Kolejność to grupowanie co najmniej jednego elementu zamówienia.
OrderResourceList	Lista zamówień.
StageDetails	Szczegóły etapu zasobu.
StageName	Nazwa etapu.
StageStatus	Stan etapu.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

OrderMode

Definiuje tryb elementu Order.

Nazwa	Typ	Opis
Default	string	Domyślny tryb kolejności.
DoNotFulfill	string	Tryb, w którym zamówienie nie zostanie spełnione.

OrderResource

Określa właściwości lub parametry dla zamówienia. Kolejność to grupowanie co najmniej jednego elementu zamówienia.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.currentStage	StageDetails	Zamów bieżący stan.
properties.orderItemIds	string[]	Lista identyfikatorów arm elementu zamówienia, które są częścią zamówienia.
properties.orderMode	OrderMode	Tryb zamówienia.
properties.orderStageHistory	StageDetails[]	Historia stanu zamówienia.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

OrderResourceList

Lista zamówień.

Nazwa	Typ	Opis
nextLink	string	Link do następnego zestawu zasobów zamówienia.
value	OrderResource[]	Lista zasobów zamówień.

StageDetails

Szczegóły etapu zasobu.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana etapu zasobu.
stageName	StageName	Nazwa etapu.
stageStatus	StageStatus	Stan etapu.
startTime	string	Czas rozpoczęcia etapu.

StageName

Nazwa etapu.

Nazwa	Typ	Opis
Cancelled	string	Zamówienie zostało anulowane.
Confirmed	string	Zamówienie zostało potwierdzone.
Delivered	string	Zamówienie jest dostarczane klientowi.
InReview	string	Kolejność jest obecnie w trybie roboczym i nadal może zostać anulowana.
InUse	string	Zamówienie jest używane w lokacji klienta.
Placed	string	Obecnie w trybie roboczym i nadal można je anulować.
ReadyToSetup	string	Zamówienie jest gotowe do nawiązania połączenia z chmurą.
ReadyToShip	string	Zamówienie jest gotowe do wysłania.
ReturnCompleted	string	Powrót został ukończony.
ReturnInitiated	string	Zwrot został zainicjowany przez klienta.
ReturnPickedUp	string	Zamówienie jest przesyłane od klienta do firmy Microsoft.
ReturnedToMicrosoft	string	Zamówienie zostało odebrane z powrotem do firmy Microsoft.
Shipped	string	Zamówienie jest przesyłane do klienta.

StageStatus

Stan etapu.

Nazwa	Typ	Opis
Cancelled	string	Etap został anulowany.
Cancelling	string	Etap jest anulowany.
Failed	string	Etap zakończył się niepowodzeniem.
InProgress	string	Etap jest w toku.
None	string	Brak jeszcze dostępnego stanu.
Succeeded	string	Etap zakończył się pomyślnie.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.