Get Address By Name - Get Address By Name

Služba:

Edge Hardware Center

Verze rozhraní API:

2021-12-01

Získá informace o zadané adrese.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
addressName	path	True	string minLength: 3 maxLength: 24 pattern: ^[-\w\.]+$	Název prostředku adresy v zadané skupině prostředků. Názvy adres musí mít délku 3 až 24 znaků a musí používat pouze alfanumerické a podtržítko.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	AddressResource	Objekt adresy
Other Status Codes	ErrorResponse	Odpověď na chybu popisující důvod selhání operace

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetAddressByName

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kó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"
}

Definice

Name	Description
AddressResource	Adresní prostředek.
AddressType	Typ adresy.
AddressValidationStatus	Stav ověření adresy
ContactDetails	Kontaktní údaje.
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ShippingAddress	Dodací adresa, kde zákazník chce zařízení obdržet.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AddressResource

Objekt

Adresní prostředek.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.addressValidationStatus	AddressValidationStatus	Stav ověření adresy
properties.contactDetails	ContactDetails	Kontaktní údaje pro adresu
properties.shippingAddress	ShippingAddress	Podrobnosti o expedici adresy
systemData	systemData	Představuje čas vytvoření a aktualizace prostředku.
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

AddressType

Výčet

Typ adresy.

Hodnota	Description
None	Typ adresy není znám.
Residential	Adresa bydliště.
Commercial	Komerční adresa.

AddressValidationStatus

Výčet

Stav ověření adresy

Hodnota	Description
Valid	Zadaná adresa je platná.
Invalid	Zadanou adresu je neplatná nebo není podporována.
Ambiguous	Zadaná adresa je nejednoznačná, zvolte jednu z vrácených alternativních adres.

ContactDetails

Objekt

Kontaktní údaje.

Name	Typ	Description
contactName	string	Jméno kontaktu osoby.
emailList	string[]	Seznam ID e-mailů, které se mají informovat o průběhu úlohy
mobile	string	Číslo mobilního kontaktu.
phone	string	Telefonní číslo kontaktní osoby.
phoneExtension	string	Telefonní číslo linky kontaktní osoby.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ShippingAddress

Objekt

Dodací adresa, kde zákazník chce zařízení obdržet.

Name	Typ	Description
addressType	AddressType	Typ adresy.
city	string	Název města.
companyName	string	Název společnosti.
country	string	Název země.
postalCode	string	Psč.
stateOrProvince	string	Název státu nebo provincie.
streetAddress1	string	Řádek adresy 1.
streetAddress2	string	Řádek adresy 2.
streetAddress3	string	Řádek adresy 3.
zipExtendedCode	string	Rozšířené PSČ.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.