Get Address By Name - Get Address By Name

Referencia

Szolgáltatás:: Edge Hardware Center

API-verzió:: 2021-12-01

Információt kap a megadott címről.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
addressName	path	True	string minLength: 3 maxLength: 24 pattern: ^[-\w\.]+$	Az erőforrás címének neve a megadott erőforráscsoporton belül. a címneveknek 3 és 24 karakter közötti hosszúságúnak kell lenniük, és csak alfanumerikus és aláhúzásjeleket kell használniuk
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	AddressResource	Címobjektum
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

GetAddressByName

Mintakérelem

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


/**
 * Samples for ResourceProvider GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/GetAddressByName.json
     */
    /**
     * Sample code: GetAddressByName.
     * 
     * @param manager Entry point to EdgeOrderManager.
     */
    public static void getAddressByName(com.azure.resourcemanager.edgeorder.EdgeOrderManager manager) {
        manager.resourceProviders().getByResourceGroupWithResponse("YourResourceGroupName", "TestAddressName1",
            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_address_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_address_by_name(
        address_name="TestAddressName1",
        resource_group_name="YourResourceGroupName",
    )
    print(response)


# x-ms-original-file: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/GetAddressByName.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/GetAddressByName.json
func ExampleManagementClient_GetAddressByName() {
	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().GetAddressByName(ctx, "TestAddressName1", "YourResourceGroupName", 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.AddressResource = armedgeorder.AddressResource{
	// 	Name: to.Ptr("TestAddressName1"),
	// 	Type: to.Ptr("Microsoft.EdgeOrder/addresses"),
	// 	ID: to.Ptr("/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1"),
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armedgeorder.AddressProperties{
	// 		AddressValidationStatus: to.Ptr(armedgeorder.AddressValidationStatusValid),
	// 		ContactDetails: &armedgeorder.ContactDetails{
	// 			ContactName: to.Ptr("XXXX XXXX"),
	// 			EmailList: []*string{
	// 				to.Ptr("xxxx@xxxx.xxx")},
	// 				Phone: to.Ptr("0000000000"),
	// 				PhoneExtension: to.Ptr(""),
	// 			},
	// 			ShippingAddress: &armedgeorder.ShippingAddress{
	// 				AddressType: to.Ptr(armedgeorder.AddressTypeNone),
	// 				City: to.Ptr("San Francisco"),
	// 				CompanyName: to.Ptr("Microsoft"),
	// 				Country: to.Ptr("US"),
	// 				PostalCode: to.Ptr("94107"),
	// 				StateOrProvince: to.Ptr("CA"),
	// 				StreetAddress1: to.Ptr("16 TOWNSEND ST"),
	// 				StreetAddress2: to.Ptr("UNIT 1"),
	// 			},
	// 		},
	// 		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.EdgeOrder.Models;
using Azure.ResourceManager.EdgeOrder;

// Generated from example definition: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/GetAddressByName.json
// this example is just showing the usage of "GetAddressByName" 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 EdgeOrderAddressResource created on azure
// for more information of creating EdgeOrderAddressResource, please refer to the document of EdgeOrderAddressResource
string subscriptionId = "fa68082f-8ff7-4a25-95c7-ce9da541242f";
string resourceGroupName = "TestRG";
string addressName = "TestMSAddressName";
ResourceIdentifier edgeOrderAddressResourceId = EdgeOrderAddressResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, addressName);
EdgeOrderAddressResource edgeOrderAddress = client.GetEdgeOrderAddressResource(edgeOrderAddressResourceId);

// invoke the operation
EdgeOrderAddressResource result = await edgeOrderAddress.GetAsync();

// 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
EdgeOrderAddressData 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": {
    "shippingAddress": {
      "streetAddress1": "16 TOWNSEND ST",
      "streetAddress2": "UNIT 1",
      "city": "San Francisco",
      "stateOrProvince": "CA",
      "country": "US",
      "postalCode": "94107",
      "companyName": "Microsoft",
      "addressType": "None"
    },
    "contactDetails": {
      "contactName": "XXXX XXXX",
      "phone": "0000000000",
      "phoneExtension": "",
      "emailList": [
        "xxxx@xxxx.xxx"
      ]
    },
    "addressValidationStatus": "Valid"
  },
  "systemData": {
    "createdAt": "0001-01-01T05:30:00+05:30",
    "lastModifiedAt": "0001-01-01T05:30:00+05:30"
  },
  "location": "eastus",
  "tags": {},
  "name": "TestAddressName1",
  "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1",
  "type": "Microsoft.EdgeOrder/addresses"
}

Definíciók

Name	Description
AddressResource	Címerőforrás.
AddressType	A cím típusa.
AddressValidationStatus	A címérvényesítés állapota
ContactDetails	Elérhetőségei.
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
ShippingAddress	Szállítási cím, ahol az ügyfél szeretné megkapni az eszközt.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

AddressResource

Objektum

Címerőforrás.

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}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.addressValidationStatus	AddressValidationStatus	A címérvényesítés állapota
properties.contactDetails	ContactDetails	A cím kapcsolattartási adatai
properties.shippingAddress	ShippingAddress	Szállítási adatok a címhez
systemData	systemData	Az erőforrás létrehozásának és frissítésének idejét jelöli
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

AddressType

Enumerálás

A cím típusa.

Érték	Description
Commercial	Kereskedelmi cím.
None	A cím típusa nem ismert.
Residential	Lakcím.

AddressValidationStatus

Enumerálás

A címérvényesítés állapota

Érték	Description
Ambiguous	A megadott cím nem egyértelmű, válasszon a visszaadott másodlagos címek közül.
Invalid	A megadott cím érvénytelen vagy nem támogatott.
Valid	A megadott cím érvényes.

ContactDetails

Objektum

Elérhetőségei.

Name	Típus	Description
contactName	string	A személy kapcsolattartójának neve.
emailList	string[]	A feladat előrehaladásáról értesítendő e-mail-azonosítók listája.
mobile	string	A kapcsolattartó mobilszáma.
phone	string	A kapcsolattartó telefonszáma.
phoneExtension	string	A kapcsolattartó telefonszáma.

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.

ShippingAddress

Objektum

Szállítási cím, ahol az ügyfél szeretné megkapni az eszközt.

Name	Típus	Description
addressType	AddressType	A cím típusa.
city	string	A város neve.
companyName	string	A vállalat neve.
country	string	Az ország neve.
postalCode	string	Irányítószám.
stateOrProvince	string	Az állam vagy tartomány neve.
streetAddress1	string	Utcacím sor 1.
streetAddress2	string	Utcacím 2. sor.
streetAddress3	string	Utcacím 3. sor.
zipExtendedCode	string	Kiterjesztett irányítószám.

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 Address By Name - Get Address By Name

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

GetAddressByName

Mintakérelem

Mintaválasz

Definíciók

AddressResource

AddressType

AddressValidationStatus

ContactDetails

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ShippingAddress

systemData