Get Order By Name - Get Order By Name

Referencia

Szolgáltatás:: Edge Hardware Center

API-verzió:: 2021-12-01

Megrendelést kap.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
location	path	True	string minLength: 1	Az Azure-régió neve.
orderName	path	True	string	A rendelés neve
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	OrderResource	Rendelési objektum
Other Status Codes	ErrorResponse	A művelethiba okát leíró hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

GetOrderByName

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
OrderResource	Megadja egy rendelés tulajdonságait vagy paramétereit. A rendelés egy vagy több rendeléselem csoportosítása.
StageDetails	Erőforrásszakasz részletei.
StageName	Fázis neve
StageStatus	Szakasz állapota.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

OrderResource

Objektum

Megadja egy rendelés tulajdonságait vagy paramétereit. A rendelés egy vagy több rendeléselem csoportosítása.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.currentStage	StageDetails	Rendelés aktuális állapota.
properties.orderItemIds	string[]	A rendelés részét képező rendeléselemek ARM-azonosítóinak listája.
properties.orderStageHistory	StageDetails[]	Rendelési állapotelőzmények.
systemData	systemData	Az erőforrás létrehozásának és frissítésének idejét jelöli
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

StageDetails

Objektum

Erőforrásszakasz részletei.

Name	Típus	Description
displayName	string	Az erőforrásszakasz megjelenítendő neve.
stageName	StageName	Fázis neve
stageStatus	StageStatus	Szakasz állapota.
startTime	string (date-time)	Szakasz kezdési ideje

StageName

Enumerálás

Fázis neve

Érték	Description
Cancelled	A rendelés törölve lett.
Confirmed	A megrendelés megerősítést nyert
Delivered	A megrendelés kézbesítése az ügyfélnek
InReview	A megrendelés jelenleg piszkozat módban van, és továbbra is lemondható
InUse	A rendelés használatban van az ügyfélwebhelyen
Placed	Jelenleg piszkozat módban van, és továbbra is lemondható
ReadyToShip	A megrendelés készen áll a szállításra
ReturnCompleted	A visszatérés befejeződött.
ReturnInitiated	A visszaküldést az ügyfél kezdeményezte.
ReturnPickedUp	A megrendelés az ügyféltől a Microsoft felé halad.
ReturnedToMicrosoft	A rendelés vissza lett adva a Microsoftnak.
Shipped	A megrendelés átvitt az ügyfélnek

StageStatus

Enumerálás

Szakasz állapota.

Érték	Description
Cancelled	A szakaszt törölték.
Cancelling	A szakasz megszakad.
Failed	A szakasz nem sikerült.
InProgress	A fázis folyamatban van.
None	Még nem érhető el állapot.
Succeeded	A szakasz sikeres volt.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Get Order By Name - Get Order By Name

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

GetOrderByName

Mintakérelem

Mintaválasz

Definíciók

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OrderResource

StageDetails

StageName

StageStatus

systemData