Get Order By Name - Get Order By Name

Referencia

Servicio:: Edge Hardware Center

Versión de la API:: 2021-12-01

Obtiene un orden.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}?api-version=2021-12-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
location	path	True	string minLength: 1	Nombre de la región de Azure.
orderName	path	True	string	Nombre del pedido
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	OrderResource	Order (objeto)
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

GetOrderByName

Solicitud de ejemplo

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


/**
 * Samples for ResourceProvider GetOrderByName.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/GetOrderByName.json
     */
    /**
     * Sample code: GetOrderByName.
     * 
     * @param manager Entry point to EdgeOrderManager.
     */
    public static void getOrderByName(com.azure.resourcemanager.edgeorder.EdgeOrderManager manager) {
        manager.resourceProviders().getOrderByNameWithResponse("TestOrderName3", "YourResourceGroupName", "eastus",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.edgeorder import EdgeOrderManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-edgeorder
# USAGE
    python get_order_by_name.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EdgeOrderManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="YourSubscriptionId",
    )

    response = client.get_order_by_name(
        order_name="TestOrderName3",
        resource_group_name="YourResourceGroupName",
        location="eastus",
    )
    print(response)


# x-ms-original-file: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/GetOrderByName.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armedgeorder_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/edgeorder/armedgeorder"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/GetOrderByName.json
func ExampleManagementClient_GetOrderByName() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armedgeorder.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagementClient().GetOrderByName(ctx, "TestOrderName3", "YourResourceGroupName", "eastus", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OrderResource = armedgeorder.OrderResource{
	// 	Name: to.Ptr("TestOrderName3"),
	// 	Type: to.Ptr("Microsoft.EdgeOrder/orders"),
	// 	ID: to.Ptr("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3"),
	// 	Properties: &armedgeorder.OrderProperties{
	// 		CurrentStage: &armedgeorder.StageDetails{
	// 			StageName: to.Ptr(armedgeorder.StageNameInReview),
	// 			StageStatus: to.Ptr(armedgeorder.StageStatusSucceeded),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T06:05:20.852Z"); return t}()),
	// 		},
	// 		OrderItemIDs: []*string{
	// 			to.Ptr("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3")},
	// 			OrderStageHistory: []*armedgeorder.StageDetails{
	// 				{
	// 					StageName: to.Ptr(armedgeorder.StageNamePlaced),
	// 					StageStatus: to.Ptr(armedgeorder.StageStatusSucceeded),
	// 					StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T06:00:30.271Z"); return t}()),
	// 				},
	// 				{
	// 					StageName: to.Ptr(armedgeorder.StageNameInReview),
	// 					StageStatus: to.Ptr(armedgeorder.StageStatusSucceeded),
	// 					StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T06:05:20.852Z"); return t}()),
	// 			}},
	// 		},
	// 		SystemData: &armedgeorder.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.EdgeOrder;

// Generated from example definition: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/GetOrderByName.json
// this example is just showing the usage of "GetOrderByName" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "fa68082f-8ff7-4a25-95c7-ce9da541242f";
string resourceGroupName = "TestRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this EdgeOrderResource
EdgeOrderCollection collection = resourceGroupResource.GetEdgeOrders();

// invoke the operation
AzureLocation location = new AzureLocation("%7B%7B%7Blocation%7D%7D");
string orderName = "TestOrderItemName901";
NullableResponse<EdgeOrderResource> response = await collection.GetIfExistsAsync(location, orderName);
EdgeOrderResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EdgeOrderData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "properties": {
    "orderItemIds": [
      "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3"
    ],
    "currentStage": {
      "stageStatus": "Succeeded",
      "stageName": "InReview",
      "startTime": "2022-03-04T11:35:20.8521455+05:30"
    },
    "orderStageHistory": [
      {
        "stageStatus": "Succeeded",
        "stageName": "Placed",
        "startTime": "2022-03-04T11:30:30.2717243+05:30"
      },
      {
        "stageStatus": "Succeeded",
        "stageName": "InReview",
        "startTime": "2022-03-04T11:35:20.8521455+05:30"
      }
    ]
  },
  "systemData": {
    "createdAt": "0001-01-01T05:30:00+05:30",
    "lastModifiedAt": "0001-01-01T05:30:00+05:30"
  },
  "name": "TestOrderName3",
  "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3",
  "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
OrderResource	Especifica las propiedades o parámetros de un pedido. Order es una agrupación de uno o varios elementos de pedido.
StageDetails	Detalles de la fase de recursos.
StageName	Nombre de la fase
StageStatus	Estado de la fase.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

Object

Detalle del error.

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

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

OrderResource

Object

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 para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.currentStage	StageDetails	Ordene el estado actual.
properties.orderItemIds	string[]	Lista de identificadores arm del elemento de pedido que forman parte de un pedido.
properties.orderStageHistory	StageDetails[]	Historial de estado del pedido.
systemData	systemData	Representa la hora de creación y actualización de los recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

StageDetails

Object

Detalles de la fase de recursos.

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

StageName

Enumeración

Nombre de la fase

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

StageStatus

Enumeración

Estado de la fase.

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

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

Compartir a través de

Get Order By Name - Get Order By Name

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

GetOrderByName

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OrderResource

StageDetails

StageName

StageStatus

systemData