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

Site Network Services - List By Subscription

Lists订阅中的网络服务中的所有站点。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/siteNetworkServices?api-version=2023-09-01

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

SiteNetworkServiceListResult

请求成功。 该操作返回网络站点资源的列表。

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

List all hybrid network sites in a subscription.

示例请求

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.HybridNetwork/siteNetworkServices?api-version=2023-09-01

示例响应

{
  "value": [
    {
      "name": "testSiteNetworkServiceName",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName",
      "type": "Microsoft.HybridNetwork/siteNetworkServices",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "location": "westUs2",
      "sku": {
        "name": "Standard",
        "tier": "Standard"
      },
      "properties": {
        "provisioningState": "Accepted",
        "siteReference": {
          "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"
        },
        "publisherName": "testPublisher",
        "publisherScope": "Public",
        "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName",
        "networkServiceDesignVersionName": "1.0.1",
        "networkServiceDesignVersionOfferingLocation": "eastus",
        "networkServiceDesignVersionResourceReference": {
          "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1",
          "idType": "Open"
        },
        "desiredStateConfigurationGroupValueReferences": {
          "MyVM_Configuration": {
            "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"
          }
        }
      }
    }
  ]
}

定义

名称 说明
createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ManagedResourceGroupConfiguration

托管资源组配置。

ManagedServiceIdentity

托管服务标识 (系统分配的标识和/或用户分配的标识)

ManagedServiceIdentityType

) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。

OpenDeploymentResourceReference

非机密部署资源 ID 引用。

ProvisioningState

当前预配状态。

PublisherScope

发布服务器范围。

ReferencedResource

对另一个资源的引用。

SecretDeploymentResourceReference

机密部署资源 ID 参考。

SiteNetworkService

站点网络服务资源。

SiteNetworkServiceListResult

站点网络服务 API 服务调用的响应。

SiteNetworkServicePropertiesFormat

站点网络服务属性。

Sku

要与 SiteNetworkService 关联的 Sku。

SkuName

此 SKU 的名称

SkuTier

基于 SKU 名称的 SKU 层。

systemData

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

UserAssignedIdentity

用户分配的标识属性

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

错误对象。

ManagedResourceGroupConfiguration

托管资源组配置。

名称 类型 说明
location

string

托管资源组位置。

name

string

托管资源组名称。

ManagedServiceIdentity

托管服务标识 (系统分配的标识和/或用户分配的标识)

名称 类型 说明
principalId

string

系统分配的标识的服务主体 ID。 此属性仅针对系统分配的标识提供。

tenantId

string

系统分配的标识的租户 ID。 此属性仅针对系统分配的标识提供。

type

ManagedServiceIdentityType

) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 标识
与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是请求中) ({} 空对象。

ManagedServiceIdentityType

) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

OpenDeploymentResourceReference

非机密部署资源 ID 引用。

名称 类型 默认值 说明
id

string

资源 ID。

idType string:

Open

Open

资源引用 arm ID 类型。

ProvisioningState

当前预配状态。

名称 类型 说明
Accepted

string

Canceled

string

Converging

string

Deleted

string

Deleting

string

Failed

string

Succeeded

string

Unknown

string

PublisherScope

发布服务器范围。

名称 类型 说明
Private

string

Unknown

string

ReferencedResource

对另一个资源的引用。

名称 类型 说明
id

string

资源 ID。

SecretDeploymentResourceReference

机密部署资源 ID 参考。

名称 类型 默认值 说明
id

string

资源 ID。

idType string:

Secret

Open

资源引用 arm ID 类型。

SiteNetworkService

站点网络服务资源。

名称 类型 说明
id

string

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

identity

ManagedServiceIdentity

站点网络服务的托管标识(如果已配置)。

location

string

资源所在的地理位置

name

string

资源的名称

properties

SiteNetworkServicePropertiesFormat

站点网络服务属性。

sku

Sku

站点网络服务的 SKU。

systemData

systemData

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

tags

object

资源标记。

type

string

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

SiteNetworkServiceListResult

站点网络服务 API 服务调用的响应。

名称 类型 说明
nextLink

string

用于获取下一组结果的 URL。

value

SiteNetworkService[]

资源组中的站点网络服务列表。

SiteNetworkServicePropertiesFormat

站点网络服务属性。

名称 类型 说明
desiredStateConfigurationGroupValueReferences

<string,  ReferencedResource>

站点网络服务资源的目标状态。 这引用了描述站点网络服务的所需状态的配置组值对象。

lastStateConfigurationGroupValueReferences

<string,  ReferencedResource>

站点网络服务资源的最后一个状态。

lastStateNetworkServiceDesignVersionName

string

站点网络服务的网络服务设计版本。

managedResourceGroupConfiguration

ManagedResourceGroupConfiguration

托管资源组配置。

networkServiceDesignGroupName

string

站点网络服务的网络服务设计组名称。

networkServiceDesignVersionName

string

站点网络服务的网络服务设计版本。

networkServiceDesignVersionOfferingLocation

string

网络服务设计产品/服务的位置。

networkServiceDesignVersionResourceReference DeploymentResourceIdReference:

网络服务设计版本资源参考。

provisioningState

ProvisioningState

站点网络服务资源的预配状态。

publisherName

string

站点网络服务的发布者名称。

publisherScope

PublisherScope

发布者的范围。

siteReference

ReferencedResource

站点详细信息

Sku

要与 SiteNetworkService 关联的 Sku。

名称 类型 说明
name

SkuName

此 SKU 的名称

tier

SkuTier

基于 SKU 名称的 SKU 层。

SkuName

此 SKU 的名称

名称 类型 说明
Basic

string

Standard

string

SkuTier

基于 SKU 名称的 SKU 层。

名称 类型 说明
Basic

string

Standard

string

systemData

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

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

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

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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

UserAssignedIdentity

用户分配的标识属性

名称 类型 说明
clientId

string

已分配标识的客户端 ID。

principalId

string

分配的标识的主体 ID。