Scaling Plans - List By Subscription

Listar planos de escala na subscrição.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans?api-version=2021-01-14-preview

Parâmetros do URI

Name In Required Type Description
subscriptionId
path True
  • string

A identificação da assinatura do alvo.

api-version
query True
  • string

A versão API a ser utilizada para esta operação.

Respostas

Name Type Description
200 OK

Recuperou com sucesso planos de escala na subscrição.

Other Status Codes

Resposta de erro de automatização descrevendo por que a operação falhou.

Exemplos

ScalingPlans_ListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/providers/Microsoft.DesktopVirtualization/scalingPlans?api-version=2021-01-14-preview

Sample Response

{
  "value": [
    {
      "name": "scalingPlan1",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1",
      "type": "Microsoft.DesktopVirtualization/scalingPlans",
      "location": "centralus",
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
        "ring": 1,
        "description": "des1",
        "friendlyName": "friendly",
        "timeZone": "",
        "hostPoolType": "Personal",
        "exclusionTag": "value",
        "schedules": [
          {
            "name": "schedule1",
            "daysOfWeek": [
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday"
            ],
            "rampUpStartTime": "2020-11-10T06:00:00.000+00:00",
            "rampUpLoadBalancingAlgorithm": "DepthFirst",
            "rampUpMinimumHostsPct": 20,
            "rampUpCapacityThresholdPct": 80,
            "peakStartTime": "2020-11-10T08:00:00.000+00:00",
            "peakLoadBalancingAlgorithm": "BreadthFirst",
            "rampDownStartTime": "2020-11-10T18:00:00.000+00:00",
            "rampDownLoadBalancingAlgorithm": "DepthFirst",
            "rampDownMinimumHostsPct": 20,
            "rampDownCapacityThresholdPct": 50,
            "rampDownForceLogoffUsers": true,
            "rampDownWaitTimeMinutes": 30,
            "rampDownNotificationMessage": "message",
            "offPeakStartTime": "2020-11-10T20:00:00.000+00:00",
            "offPeakLoadBalancingAlgorithm": "DepthFirst"
          }
        ],
        "hostPoolReferences": [
          {
            "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
            "scalingPlanEnabled": true
          }
        ]
      }
    },
    {
      "name": "scalingPlan2",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2",
      "type": "Microsoft.DesktopVirtualization/scalingPlans",
      "location": "centralus",
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "properties": {
        "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
        "ring": 1,
        "description": "des1",
        "friendlyName": "friendly",
        "timeZone": "",
        "hostPoolType": "Personal",
        "exclusionTag": "value",
        "schedules": [
          {
            "name": "schedule1",
            "daysOfWeek": [
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday"
            ],
            "rampUpStartTime": "2020-11-10T06:00:00.000+00:00",
            "rampUpLoadBalancingAlgorithm": "DepthFirst",
            "rampUpMinimumHostsPct": 20,
            "rampUpCapacityThresholdPct": 80,
            "peakStartTime": "2020-11-10T08:00:00.000+00:00",
            "peakLoadBalancingAlgorithm": "BreadthFirst",
            "rampDownStartTime": "2020-11-10T18:00:00.000+00:00",
            "rampDownLoadBalancingAlgorithm": "DepthFirst",
            "rampDownMinimumHostsPct": 20,
            "rampDownCapacityThresholdPct": 50,
            "rampDownForceLogoffUsers": false,
            "rampDownStopHostsWhen": "ZeroActiveSessions",
            "offPeakStartTime": "2020-11-10T20:00:00.000+00:00",
            "offPeakLoadBalancingAlgorithm": "DepthFirst"
          }
        ],
        "hostPoolReferences": [
          {
            "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
            "scalingPlanEnabled": true
          }
        ]
      }
    }
  ]
}

Definições

CloudError
CloudErrorProperties
HostPoolType

Tipo HostPool para desktop.

Identity
Plan
ResourceIdentityType

O tipo de identidade.

ScalingHostPoolReference

Escalada de referência do plano para hostpool.

ScalingPlan

Plano de Escala

ScalingPlanList

EscalandoPlanList

ScalingSchedule

Horário do plano de escala.

SessionHostLoadBalancingAlgorithm

Algoritmo de equilíbrio de carga para o período de rampa.

Sku
SkuTier

Este campo é obrigado a ser implementado pelo Fornecedor de Recursos se o serviço tiver mais de um nível, mas não for necessário num PUT.

StopHostsWhen

Especifica quando parar os hospedeiros durante o período de descida da rampa.

CloudError

Name Type Description
error

CloudErrorProperties

Name Type Description
code
  • string

Código de erro

message
  • string

Mensagem de erro indicando por que a operação falhou.

HostPoolType

Tipo HostPool para desktop.

Name Type Description
BYODesktop
  • string

Os utilizadores atribuem as suas próprias máquinas, a lógica de equilíbrio de carga permanece a mesma que a Personal. PersonalDesktopAssignmentType deve ser direto.

Personal
  • string

Os utilizadores serão atribuídos a um SessionHost quer por administradores (PersonalDesktopAssignmentType = Direto) quer ao ligarem-se ao pool (PersonalDesktopAssignmentType = Automático). Serão sempre redirecionados para o SessionHost designado.

Pooled
  • string

Os utilizadores obtêm um novo SessionHost (aleatório) sempre que se conecta ao HostPool.

Identity

Name Type Description
principalId
  • string

A identificação principal da identidade dos recursos.

tenantId
  • string

A identificação do inquilino de recursos.

type

O tipo de identidade.

Plan

Name Type Description
name
  • string

Um nome definido pelo utilizador do 3º Artefacto da Terceira Parte que está a ser adquirido.

product
  • string

O artefacto do 3º Partido que está a ser adquirido. Por exemplo, O NewRelic. Mapas de produtos para a OfertaID especificados para o artefacto no momento do mercado de dados no embarque.

promotionCode
  • string

Um editor forneceu o código de promoção como previsto no Mercado de Dados para o referido produto/artefacto.

publisher
  • string

O editor do 3º Artefacto da 3ª Parte que está a ser comprado. Por exemplo, Novo Relíquia

version
  • string

A versão do produto/artefacto desejado.

ResourceIdentityType

O tipo de identidade.

Name Type Description
SystemAssigned
  • string

ScalingHostPoolReference

Escalada de referência do plano para hostpool.

Name Type Description
hostPoolArmPath
  • string

Caminho do braço da piscina de anfitriões referenciada.

scalingPlanEnabled
  • boolean

É o plano de escala habilitado para esta hostpool.

ScalingPlan

Plano de Escala

Name Type Description
etag
  • string

O campo etag não é necessário. Se for fornecido no organismo de resposta, deve também ser fornecido como cabeçalho de acordo com a convenção normal de etag. As etiquetas de entidade são utilizadas para comparar duas ou mais entidades do mesmo recurso solicitado. HTTP/1.1 utiliza etiquetas de entidade nos campos de cabeçalho etag (secção 14.19), If-Match (secção 14.24), If-None-Match (secção 14.26) e If-Range (secção 14.27).

id
  • string

Identificação de recursos totalmente qualificada para o recurso. Ex - /subscrições/{subscriçãoD}/resourceGroups/{resourceGroupName}/fornecedores/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity
kind
  • string

Metadados utilizados pelo portal/ferramenta/etc para tornar diferentes experiências UX para recursos do mesmo tipo; por exemplo, os ApiApps são uma espécie de tipo Microsoft.Web/sites. Se for suportado, o fornecedor de recursos deve validar e persistir este valor.

location
  • string

A geolocalização onde o recurso vive

managedBy
  • string

O ID de recursos totalmente qualificado do recurso que gere este recurso. Indica se este recurso é gerido por outro recurso Azure. Se isto estiver presente, a implementação completa do modo não eliminará o recurso se for removido do modelo uma vez que é gerido por outro recurso.

name
  • string

O nome do recurso

plan
properties.description
  • string

Descrição do plano de escala.

properties.exclusionTag
  • string

Etiqueta de exclusão para plano de escala.

properties.friendlyName
  • string

Nome amigável do plano de escala.

properties.hostPoolReferences

Lista de definições de ScalingHostPoolReference.

properties.hostPoolType

Tipo HostPool para desktop.

properties.objectId
  • string

ObjectId do plano de escala. (utilização interna)

properties.ring
  • integer

O número do anel do plano de escala.

properties.schedules

Lista de definições de ScalingSchedule.

properties.timeZone
  • string

Timezone do plano de escala.

sku
tags
  • object

Etiquetas de recursos.

type
  • string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScalingPlanList

EscalandoPlanList

Name Type Description
nextLink
  • string

Ligue para a próxima página de resultados.

value

Lista de definições de plano de escala.

ScalingSchedule

Horário do plano de escala.

Name Type Description
daysOfWeek
  • string[]

Conjunto de dias da semana em que este horário está ativo.

name
  • string

O nome do horário de escala.

offPeakLoadBalancingAlgorithm

Algoritmo de equilíbrio de carga para o período fora do pico.

offPeakStartTime
  • string

Hora de partida para o período fora do pico.

peakLoadBalancingAlgorithm

Algoritmo de equilíbrio de carga para o período de pico.

peakStartTime
  • string

Hora de início para o período de pico.

rampDownCapacityThresholdPct
  • integer

Limiar de capacidade para o período de descida da rampa.

rampDownForceLogoffUsers
  • boolean

Se os utilizadores forem desligados com força dos anfitriões.

rampDownLoadBalancingAlgorithm

Algoritmo de equilíbrio de carga para o período de descida da rampa.

rampDownMinimumHostsPct
  • integer

Percentagem mínima de hospedeiro para o período de descida da rampa.

rampDownNotificationMessage
  • string

Mensagem de notificação para os utilizadores durante o período de descida da rampa.

rampDownStartTime
  • string

Hora de início para o período de descida da rampa.

rampDownStopHostsWhen

Especifica quando parar os hospedeiros durante o período de descida da rampa.

rampDownWaitTimeMinutes
  • integer

Número de minutos para esperar para parar os anfitriões durante o período de descida da rampa.

rampUpCapacityThresholdPct
  • integer

Limiar de capacidade para o período de subida.

rampUpLoadBalancingAlgorithm

Algoritmo de equilíbrio de carga para o período de rampa.

rampUpMinimumHostsPct
  • integer

Percentagem mínima de hospedeiro para o período de subida.

rampUpStartTime
  • string

Hora de início para o período de rampa.

SessionHostLoadBalancingAlgorithm

Algoritmo de equilíbrio de carga para o período de rampa.

Name Type Description
BreadthFirst
  • string
DepthFirst
  • string

Sku

Name Type Description
capacity
  • integer

Se o SKU suportar a escala para fora/dentro, então o inteiro de capacidade deve ser incluído. Se a escala não for possível para o recurso, esta pode ser omitida.

family
  • string

Se o serviço tem diferentes gerações de hardware, para o mesmo SKU, então isso pode ser capturado aqui.

name
  • string

O nome do SKU. Ex - P3. É tipicamente um código de letra+número

size
  • string

O tamanho SKU. Quando o campo de nomes é a combinação de nível e algum outro valor, este seria o código autónomo.

tier

Este campo é obrigado a ser implementado pelo Fornecedor de Recursos se o serviço tiver mais de um nível, mas não for necessário num PUT.

SkuTier

Este campo é obrigado a ser implementado pelo Fornecedor de Recursos se o serviço tiver mais de um nível, mas não for necessário num PUT.

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string

StopHostsWhen

Especifica quando parar os hospedeiros durante o período de descida da rampa.

Name Type Description
ZeroActiveSessions
  • string
ZeroSessions
  • string