Partager via


List Order At Subscription Level - List Order At Subscription Level

Listes commande au niveau de l’abonnement.

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

Paramètres URI

Nom Dans Obligatoire Type Description
subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

$skipToken
query

string

$skipToken est pris en charge dans Obtenir la liste de l’ordre, qui fournit la page suivante dans la liste de l’ordre.

Réponses

Nom Type Description
200 OK

OrderResourceList

Objet Order

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ListOrderAtSubscriptionLevel

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

OrderResource

Spécifie les propriétés ou paramètres d’une commande. Order est un regroupement d’un ou plusieurs éléments de commande.

OrderResourceList

Liste des commandes.

StageDetails

Détails de l’étape de ressource.

StageName

Nom de la phase

StageStatus

Status d’étape.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

OrderResource

Spécifie les propriétés ou paramètres d’une commande. Order est un regroupement d’un ou plusieurs éléments de commande.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties.currentStage

StageDetails

État actuel de la commande.

properties.orderItemIds

string[]

Liste des ID ARM d’élément de commande qui font partie d’une commande.

properties.orderStageHistory

StageDetails[]

Historique des commandes status.

systemData

systemData

Représente l’heure de création et de mise à jour des ressources

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

OrderResourceList

Liste des commandes.

Nom Type Description
nextLink

string

Lien pour l’ensemble suivant de ressources d’ordre.

value

OrderResource[]

Liste des ressources de commande.

StageDetails

Détails de l’étape de ressource.

Nom Type Description
displayName

string

Nom d’affichage de la phase de ressource.

stageName

StageName

Nom de la phase

stageStatus

StageStatus

Status d’étape.

startTime

string

Heure de début de la phase

StageName

Nom de la phase

Nom Type Description
Cancelled

string

La commande a été annulée.

Confirmed

string

La commande est confirmée

Delivered

string

La commande est livrée au client

InReview

string

La commande est actuellement en mode brouillon et peut toujours être annulée

InUse

string

La commande est en cours d’utilisation sur le site du client

Placed

string

Actuellement en mode brouillon et peut toujours être annulé

ReadyToShip

string

La commande est prête à être expédiée

ReturnCompleted

string

Le retour est maintenant terminé.

ReturnInitiated

string

Le retour a été initié par le client.

ReturnPickedUp

string

La commande est en transit du client vers Microsoft.

ReturnedToMicrosoft

string

La commande a été renvoyée à Microsoft.

Shipped

string

La commande est en transit vers le client

StageStatus

Status d’étape.

Nom Type Description
Cancelled

string

L’étape a été annulée.

Cancelling

string

L’étape est annulée.

Failed

string

La phase a échoué.

InProgress

string

L’étape est en cours.

None

string

Aucune status encore disponible.

Succeeded

string

La phase a réussi.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la dernière ressource.

lastModifiedByType

createdByType

Type d’identité qui a modifié la dernière ressource.