Addresses - Update

Referenz

Dienst:: Edge Hardware Center

API-Version:: 2024-02-01

Dient zum Aktualisieren der Eigenschaften einer vorhandenen Adresse.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
addressName	path	True	string minLength: 3 maxLength: 24 pattern: ^[-\w\.]+$	Der Name der Adresse Ressource innerhalb der angegebenen Ressourcengruppe. Adressnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	Definiert die If-Match Bedingung. Der Patch wird nur ausgeführt, wenn das ETag des Auftrags auf dem Server mit diesem Wert übereinstimmt.

Anforderungstext

Name	Typ	Beschreibung
properties.contactDetails	ContactDetails	Kontaktdetails für die Adresse.
properties.shippingAddress	ShippingAddress	Lieferdetails für die Adresse.
tags	object	Die Liste der Schlüsselwertpaare, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden.

Antworten

Name	Typ	Beschreibung
200 OK	AddressResource	Adressressourcenobjekt.
202 Accepted		Akzeptierte Anforderung für die Adressaktualisierung. Header Location: string
Other Status Codes	ErrorResponse	Fehlerantwort, die den Grund für Vorgangsfehler beschreibt.

Name

Typ

Beschreibung

200 OK

AddressResource

Adressressourcenobjekt.

202 Accepted

Akzeptierte Anforderung für die Adressaktualisierung.

Header

Location: string

Other Status Codes

ErrorResponse

Fehlerantwort, die den Grund für Vorgangsfehler beschreibt.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

UpdateAddress

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2?api-version=2024-02-01

{
  "properties": {
    "shippingAddress": {
      "streetAddress1": "16 TOWNSEND ST",
      "streetAddress2": "UNIT 1",
      "city": "San Francisco",
      "stateOrProvince": "CA",
      "country": "US",
      "postalCode": "94107",
      "companyName": "Microsoft",
      "addressType": "None"
    },
    "contactDetails": {
      "contactName": "YYYY YYYY",
      "phone": "0000000000",
      "phoneExtension": "",
      "emailList": [
        "xxxx@xxxx.xxx"
      ]
    }
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Beispiel für eine Antwort

Statuscode:: 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": "YYYY YYYY",
      "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": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "name": "TestAddressName2",
  "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2",
  "type": "Microsoft.EdgeOrder/addresses"
}

Statuscode:: 202

location: https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/locations/westus/operationResults/operationid?api-version=2024-02-01

Definitionen

Name	Beschreibung
AddressClassification	Typ der Adresse basierend auf dem Verwendungskontext.
AddressResource	Adressressource.
AddressType	Typ der Adresse.
AddressUpdateParameter	Die Parameter für die Adressaktualisierung.
AddressValidationStatus	Status der Adressüberprüfung.
ContactDetails	Kontaktangaben.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ProvisioningState	Bereitstellungsstatus
ShippingAddress	Versandadresse, an der der Kunde das Gerät erhalten möchte.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AddressClassification

Enumeration

Typ der Adresse basierend auf dem Verwendungskontext.

Wert	Beschreibung
Shipping	Versandadresse für die Bestellung.
Site	Websiteadresse.

AddressResource

Objekt

Adressressource.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.addressClassification	AddressClassification	Typ der Adresse basierend auf dem Verwendungskontext.
properties.addressValidationStatus	AddressValidationStatus	Status der Adressüberprüfung.
properties.contactDetails	ContactDetails	Kontaktdetails für die Adresse.
properties.provisioningState	ProvisioningState	Bereitstellungsstatus
properties.shippingAddress	ShippingAddress	Lieferdetails für die Adresse.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AddressType

Enumeration

Typ der Adresse.

Wert	Beschreibung
Commercial	Handelsadresse.
None	Der Adresstyp ist nicht bekannt.
Residential	Wohnadresse.

AddressUpdateParameter

Objekt

Die Parameter für die Adressaktualisierung.

Name	Typ	Beschreibung
properties.contactDetails	ContactDetails	Kontaktdetails für die Adresse.
properties.shippingAddress	ShippingAddress	Lieferdetails für die Adresse.
tags	object	Die Liste der Schlüsselwertpaare, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden.

AddressValidationStatus

Enumeration

Status der Adressüberprüfung.

Wert	Beschreibung
Ambiguous	Die angegebene Adresse ist mehrdeutig. Wählen Sie eine der zurückgegebenen alternativen Adressen aus.
Invalid	Die angegebene Adresse ist ungültig oder wird nicht unterstützt.
Valid	Die angegebene Adresse ist gültig.

ContactDetails

Objekt

Kontaktangaben.

Name	Typ	Beschreibung
contactName	string	Kontaktname der Person.
emailList	string[]	Liste der E-Mail-IDs, die über den Auftragsfortschritt benachrichtigt werden sollen.
mobile	string	Mobiltelefonnummer der Kontaktperson.
phone	string	Telefonnummer der Kontaktperson.
phoneExtension	string	Telefonnummer der Kontaktperson.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ProvisioningState

Enumeration

Bereitstellungsstatus

Wert	Beschreibung
Canceled	Status abgebrochen.
Creating	Zustand wird erstellt.
Failed	Gescheiterter Staat.
Succeeded	Status erfolgreich.

ShippingAddress

Objekt

Versandadresse, an der der Kunde das Gerät erhalten möchte.

Name	Typ	Beschreibung
addressType	AddressType	Typ der Adresse.
city	string	Name der Stadt.
companyName	string	Name des Unternehmens.
country	string	Name des Landes.
postalCode	string	Postleitzahl.
stateOrProvince	string	Name des Staates oder der Provinz.
streetAddress1	string	Straße Zeile 1.
streetAddress2	string	Straße Zeile 2.
streetAddress3	string	Straße Zeile 3.
zipExtendedCode	string	Erweiterte Postleitzahl.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Addresses - Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

UpdateAddress

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AddressClassification

AddressResource

AddressType

AddressUpdateParameter

AddressValidationStatus

ContactDetails

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

ShippingAddress

systemData