Scaling Plans - List By Host Pool

Liste o plano de dimensionamento associado ao hostpool.

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

Parâmetros de URI

Name In Required Type Description
hostPoolName
path True
  • string

O nome do pool de host dentro do grupo de recursos especificado

resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

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

Respostas

Name Type Description
200 OK

Plano de dimensionamento recuperado com êxito associado ao hostpool.

Other Status Codes

Resposta de erro de automação que descreve por que a operação falhou.

Exemplos

UserSession_SendMessage_Post

Sample Request

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/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
          }
        ]
      }
    }
  ]
}

Definições

CloudError
CloudErrorProperties
HostPoolType

Tipo hostPool para área de trabalho.

Identity
Plan
ResourceIdentityType

O tipo de identidade.

ScalingHostPoolReference

Referência do plano de dimensionamento para hostpool.

ScalingPlan

ScalingPlan

ScalingPlanList

ScalingPlanList

ScalingSchedule

Agendamento do plano de dimensionamento.

SessionHostLoadBalancingAlgorithm

Algoritmo de balanceamento de carga para o período de aumento.

Sku
SkuTier

Esse campo será necessário para ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

StopHostsWhen

Especifica quando parar hosts durante o período de rampa.

CloudError

Name Type Description
error

CloudErrorProperties

Name Type Description
code
  • string

Código do erro

message
  • string

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

HostPoolType

Tipo hostPool para área de trabalho.

Name Type Description
BYODesktop
  • string

Os usuários atribuem seus próprios máquinas, a lógica de balanceamento de carga permanece a mesma que Pessoal. PersonalDesktopAssignmentType deve ser Direct.

Personal
  • string

Os usuários receberão um SessionHost por administradores (PersonalDesktopAssignmentType = Direct) ou ao se conectar ao pool (PersonalDesktopAssignmentType = Automatic). Eles sempre serão redirecionados para o SessionHost atribuído.

Pooled
  • string

Os usuários recebem um novo SessionHost (aleatório) sempre que se conectam ao HostPool.

Identity

Name Type Description
principalId
  • string

A ID da entidade de identidade do recurso.

tenantId
  • string

A ID do locatário do recurso.

type

O tipo de identidade.

Plan

Name Type Description
name
  • string

Um nome definido pelo usuário do Artefato de Terceiros que está sendo adquirido.

product
  • string

O artefato de terceiros que está sendo adquirido. Por ex.: NewRelic. O produto é mapeado para a OfferID especificada para o artefato no momento da integração do Data Market.

promotionCode
  • string

Um editor forneceu código de promoção conforme provisionado no Data Market para o produto/artefato.

publisher
  • string

O editor do Artefato de Terceiros que está sendo comprado. Por ex.: NewRelic

version
  • string

A versão do produto/artefato desejado.

ResourceIdentityType

O tipo de identidade.

Name Type Description
SystemAssigned
  • string

ScalingHostPoolReference

Referência do plano de dimensionamento para hostpool.

Name Type Description
hostPoolArmPath
  • string

Caminho do arm do hostpool referenciado.

scalingPlanEnabled
  • boolean

É o plano de dimensionamento habilitado para esse hostpool.

ScalingPlan

ScalingPlan

Name Type Description
etag
  • string

O campo etag não é necessário. Se for fornecido no corpo da resposta, ele também deverá ser fornecido como um header de acordo com a convenção de etag normal. As marcas de entidade são usadas para comparar duas ou mais entidades do mesmo recurso solicitado. HTTP/1.1 usa marcas de entidade nos campos de cabeçalho etag (seção 14.19), If-Match (seção 14.24), If-None-Match (seção 14.26) e If-Range (seção 14.27).

id
  • string

ID de recurso totalmente qualificada para o recurso. Por ex- /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity
kind
  • string

Metadados usados pelo portal/ferramentas/etc para renderizar diferentes experiências de experiência do usuário para recursos do mesmo tipo; Por exemplo, ApiApps são um tipo de Microsoft.Web/sites. Se tiver suporte, o provedor de recursos deverá validar e persistir esse valor.

location
  • string

A localização geográfica em que o recurso reside

managedBy
  • string

A ID de recurso totalmente qualificada do recurso que gerencia esse recurso. Indica se esse recurso é gerenciado por outro recurso do Azure. Se isso estiver presente, a implantação de modo completo não excluirá o recurso se ele for removido do modelo, pois ele é gerenciado por outro recurso.

name
  • string

O nome do recurso

plan
properties.description
  • string

Descrição do plano de dimensionamento.

properties.exclusionTag
  • string

Marca de exclusão para o plano de dimensionamento.

properties.friendlyName
  • string

Nome amigável do plano de dimensionamento.

properties.hostPoolReferences

Lista de definições scalingHostPoolReference.

properties.hostPoolType

Tipo hostPool para área de trabalho.

properties.objectId
  • string

ObjectId do plano de dimensionamento. (uso interno)

properties.ring
  • integer

O número do anel do plano de dimensionamento.

properties.schedules

Lista de definições scalingSchedule.

properties.timeZone
  • string

Timezone do plano de dimensionamento.

sku
tags
  • object

Marcas de recurso.

type
  • string

Tipo do recurso. Por ex.: "Microsoft.Compute/virtualMachines" ou "Microsoft. Armazenamento/storageAccounts"

ScalingPlanList

ScalingPlanList

Name Type Description
nextLink
  • string

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

value

Lista de definições de plano de dimensionamento.

ScalingSchedule

Agendamento do plano de dimensionamento.

Name Type Description
daysOfWeek
  • string[]

Conjunto de dias da semana em que essa agenda está ativa.

name
  • string

Nome da agenda de dimensionamento.

offPeakLoadBalancingAlgorithm

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

offPeakStartTime
  • string

Hora de início do período fora do pico.

peakLoadBalancingAlgorithm

Algoritmo de balanceamento de carga para o período de pico.

peakStartTime
  • string

Hora de início do período de pico.

rampDownCapacityThresholdPct
  • integer

Limite de capacidade para o período de rampa.

rampDownForceLogoffUsers
  • boolean

Os usuários devem ser desconectados com força dos hosts.

rampDownLoadBalancingAlgorithm

Algoritmo de balanceamento de carga para o período de rampa.

rampDownMinimumHostsPct
  • integer

Percentual mínimo de host para o período de rampa.

rampDownNotificationMessage
  • string

Mensagem de notificação para usuários durante o período de rampa.

rampDownStartTime
  • string

Hora de início do período de rampa.

rampDownStopHostsWhen

Especifica quando parar hosts durante o período de rampa.

rampDownWaitTimeMinutes
  • integer

Número de minutos para aguardar a parada dos hosts durante o período de reba de rampa.

rampUpCapacityThresholdPct
  • integer

Limite de capacidade para o período de aumento.

rampUpLoadBalancingAlgorithm

Algoritmo de balanceamento de carga para o período de aumento.

rampUpMinimumHostsPct
  • integer

Percentual mínimo de host para o período de aumento.

rampUpStartTime
  • string

Hora de início do período de aumento.

SessionHostLoadBalancingAlgorithm

Algoritmo de balanceamento de carga para o período de aumento.

Name Type Description
BreadthFirst
  • string
DepthFirst
  • string

Sku

Name Type Description
capacity
  • integer

Se o SKU dá suporte a escalar/entrar, o inteiro de capacidade deve ser incluído. Se a replicação/replicação não for possível para o recurso, isso poderá ser omitido.

family
  • string

Se o serviço tiver gerações diferentes de hardware, para o mesmo SKU, isso poderá ser capturado aqui.

name
  • string

O nome da SKU. Por ex- P3. Normalmente, é um código de letra+número

size
  • string

O tamanho da SKU. Quando o campo de nome é a combinação de camada e algum outro valor, esse seria o código autônomo.

tier

Esse campo será necessário para ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

SkuTier

Esse campo será necessário para ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

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

StopHostsWhen

Especifica quando parar hosts durante o período de rampa.

Name Type Description
ZeroActiveSessions
  • string
ZeroSessions
  • string