你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Addresses - List By Subscription

列出订阅下可用的所有地址。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses?api-version=2024-02-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/addresses?api-version=2024-02-01&$filter={$filter}&$skipToken={$skipToken}&$top={$top}

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

uuid

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

要用于此操作的 API 版本。

$filter
query

string

支持$filter根据送货地址属性进行筛选。 Filter 仅支持等于运算。

$skipToken
query

string

获取地址列表支持$skipToken,该列表提供地址列表中的下一页。

$top
query

integer

int32

提取资源列表时支持$top。 $top=10 表示列表中的前 10 个项将返回到 API 调用方。

响应

名称 类型 说明
200 OK

AddressResourceList

订阅下可用的地址列表。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ListAddressesAtSubscriptionLevel

示例请求

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

示例响应

{
  "value": [
    {
      "properties": {
        "addressClassification": "Shipping",
        "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/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName1",
      "type": "Microsoft.EdgeOrder/addresses"
    },
    {
      "properties": {
        "addressClassification": "Shipping",
        "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": "TestAddressName2",
      "id": "/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/addresses/TestAddressName2",
      "type": "Microsoft.EdgeOrder/addresses"
    }
  ]
}

定义

名称 说明
AddressClassification

基于其使用上下文的地址类型。

AddressResource

地址资源。

AddressResourceList

地址资源集合。

AddressType

地址类型。

AddressValidationStatus

地址验证的状态。

ContactDetails

联系人详细信息。

createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ProvisioningState

正在设置状态

ShippingAddress

客户希望接收设备的送货地址。

systemData

与资源的创建和上次修改相关的元数据。

AddressClassification

基于其使用上下文的地址类型。

名称 类型 说明
Shipping

string

订单的送货地址。

Site

string

站点地址:

AddressResource

地址资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

location

string

资源所在的地理位置

name

string

资源的名称

properties.addressClassification

AddressClassification

基于其使用上下文的地址类型。

properties.addressValidationStatus

AddressValidationStatus

地址验证的状态。

properties.contactDetails

ContactDetails

地址的联系人详细信息。

properties.provisioningState

ProvisioningState

正在设置状态

properties.shippingAddress

ShippingAddress

地址的寄送详细信息。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

AddressResourceList

地址资源集合。

名称 类型 说明
nextLink

string

下一组作业资源的链接。

value

AddressResource[]

地址资源列表。

AddressType

地址类型。

名称 类型 说明
Commercial

string

商业地址。

None

string

地址类型未知。

Residential

string

住宅地址。

AddressValidationStatus

地址验证的状态。

名称 类型 说明
Ambiguous

string

提供的地址不明确,请选择返回的备用地址之一。

Invalid

string

提供的地址无效或不受支持。

Valid

string

提供的地址有效。

ContactDetails

联系人详细信息。

名称 类型 说明
contactName

string

此人的联系人姓名。

emailList

string[]

要通知作业进度的Email ID 列表。

mobile

string

联系人的移动电话号码。

phone

string

联系人的电话号码。

phoneExtension

string

联系人的电话分机号。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ProvisioningState

正在设置状态

名称 类型 说明
Canceled

string

已取消状态。

Creating

string

正在创建状态。

Failed

string

失败状态。

Succeeded

string

成功状态。

ShippingAddress

客户希望接收设备的送货地址。

名称 类型 说明
addressType

AddressType

地址类型。

city

string

城市的名称。

companyName

string

公司名称。

country

string

国家/地区的名称。

postalCode

string

邮政编码。

stateOrProvince

string

省/自治区/直辖市或省的名称。

streetAddress1

string

街道地址行 1。

streetAddress2

string

街道地址行 2。

streetAddress3

string

街道地址行 3。

zipExtendedCode

string

扩展邮政编码。

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。