VM 角色的 URL 备忘单 [SPFSDK][VMROLE]

 

适用于:Windows Azure Pack

服务管理 API 是基于 HTTP REST 的服务。 若要使用与 VM 角色相关的功能,请使用特定 URL 结构。 本主题提供有关使用 VM 角色时可用的所有 URL 的指南。 它描述每个 URL 使用的对象类型,以及通过 URL 对这些对象可用的操作(如果有的话)。

重要

每当对库和云服务使用 URL 时,都必须追加 api-version=2013-03 查询字符串。 查询字符串始终以 URL 后面的 ? 字符开头。 例如,若要访问名为 TestService 的云服务,请使用以下 URL:https:// server-nameserver-port/subscription-id/CloudServices/TestService?api-version=2013-03。

常见 URL 占位符

在整个编程指南 URL 中,将使用需要有关基础结构的信息(例如之前创建的对象的服务器名称或名称)。 以下列表描述了使用的所有占位符。

占位符名称

说明

server-name

服务管理 API 服务器的服务器名称。

server-port

服务管理 API 服务器的身份验证端口。

subscription-id

托管 VM 角色的云服务的名称。

cloudservice-name

托管 VM 角色的云服务的名称。

vmrole-name

VM 角色的名称。

vm-id

虚拟机的标识符。

disk-id

虚拟硬盘的标识符。

nic-id

虚拟网络适配器的标识符。

  • subscription-id/Gallery/GalleryItems
    支持的 HTTP 操作:GET。

    提供对指定订阅可用的库项的访问权限。 返回的项不限于 VM 角色,而是所有库项,无论类型如何。

  • subscription-id/Gallery/GalleryItems (publisher,name,version)
    支持的 HTTP 操作:GET。

    提供对指定订阅可用的特定库项的访问权限。

  • subscription-id/Gallery/GalleryItems/$/MicrosoftCompute.VMRoleGalleryItem
    支持的 HTTP 操作:GET。

    提供对指定订阅可用的 VM 角色库项的访问权限。

    有关使用此 URL 的示例,请参阅:

  • subscription-id/Gallery/GalleryItems/$/MicrosoftCompute.VMRoleGalleryItem (publisher,name,version)
    支持的 HTTP 操作:GET。

    提供对指定订阅可用的特定 VM 角色库项的访问权限。

    有关使用此 URL 的示例,请参阅:

云服务

  • subscription-id/CloudServices
    支持的 HTTP 操作:GET、POST。

    提供对为指定订阅创建的云服务的访问权限。 可以使用 POST 操作创建云服务。

    有关使用此 URL 的示例,请参阅:

  • subscription-id/CloudServices/cloudservice-name
    支持的 HTTP 操作:GET、PUT、PATCH、DELETE。

    提供对指定订阅创建的特定云服务的访问权限。 URL 标识的云服务可以更新和删除。

  • subscription-id/CloudServices/cloudservice-name/Resources
    支持的 HTTP 操作:GET。

    提供对指定云服务可用的资源提供程序的访问权限。

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute
    支持的 HTTP 操作:GET。

    提供对托管 VM 角色的 MicrosoftCompute 资源提供程序的访问权限。

VM 角色

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles
    支持的 HTTP 操作:GET、POST。

    提供对已创建的 VM 角色实例的访问权限。 此 URL 还用于将新的 VM 角色实例提交到服务器。

    有关使用此 URL 的示例,请参阅:

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name
    支持的 HTTP 操作:GET、PUT、PATCH、DELETE。

    按名称提供对特定 VM 角色的访问权限。 此 URL 用于删除和更新 VM 角色。

    有关使用此 URL 的示例,请参阅:

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/Scale
    支持的 HTTP 操作:POST。

    在指定的 VM 角色上启动缩放操作。

    有关使用此 URL 的示例,请参阅:

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/Repair
    支持的 HTTP 操作:POST。

    在指定的 VM 角色上启动“修复”操作。

    有关使用此 URL 的示例,请参阅:

虚拟机

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM
    支持的 HTTP 操作:GET。

    提供对托管在特定 VM 角色中的虚拟机的访问权限。

    有关使用此 URL 的示例,请参阅:

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id
    支持的 HTTP 操作:GET、DELETE。

    通过托管在特定 VM 角色中的标识符提供对虚拟机的访问。 此 URL 可用于从 VM 角色中删除特定虚拟机。

    有关使用此 URL 的示例,请参阅:

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id/Stop
    支持的 HTTP 操作:POST。

    停止标识的虚拟机。

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id/"开始"菜单
    支持的 HTTP 操作:POST。

    启动标识的虚拟机。

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id/Restart
    支持的 HTTP 操作:POST。

    重启已标识的虚拟机。

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id/Shutdown
    支持的 HTTP 操作:POST。

    关闭标识的虚拟机。

虚拟磁盘和虚拟网络适配器

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id/Disks
    支持的 HTTP 操作:GET、POST。

    提供对已标识虚拟机的虚拟磁盘的访问。 此 URL 还可用于使用 POST 操作将虚拟磁盘附加到虚拟机。

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id/Disks/disk-id
    支持的 HTTP 操作:GET、PUT、PATCH、DELETE。

    提供对指定虚拟磁盘的访问。

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id/Nics
    支持的 HTTP 操作:GET。

    提供对已标识虚拟机的虚拟网络适配器的访问。

  • subscription-id/CloudServices/cloudservice-name/Resources/MicrosoftCompute/VMRoles/vmrole-name/VM/vm-id/Nics/nic-id
    支持的 HTTP 操作:GET。

    提供对指定虚拟网络适配器的访问。