Scaling Plans - Update

Atualize um plano de dimensionamento.

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

Parâmetros de URI

Name In Required Type Description
resourceGroupName
path True
  • string

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

scalingPlanName
path True
  • string

O nome do plano de dimensionamento.

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.

Corpo da solicitação

Name Type Description
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 do usuário.

properties.hostPoolReferences

Lista de definições de ScalingHostPoolReference.

properties.hostPoolType

Tipo de HostPool para área de trabalho.

properties.ring
  • integer

O número de anel do plano de dimensionamento.

properties.schedules

Lista de definições de ScalingSchedule.

properties.timeZone
  • string

Fuso horário do plano de dimensionamento.

tags
  • object

marcas a serem atualizadas

Respostas

Name Type Description
200 OK

Plano de dimensionamento atualizado com êxito.

Other Status Codes

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

Exemplos

ScalingPlans_Update

Sample Request

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

Sample Response

{
  "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 de HostPool para área de trabalho.

Identity
Plan
ResourceIdentityType

O tipo de identidade.

ScalingHostPoolReference

Dimensionando referência de plano para hostpool.

ScalingPlan

ScalingPlan

ScalingPlanPatch

Dimensionando Propriedades do plano que podem ser corrigidas.

ScalingSchedule

Agenda do plano de dimensionamento.

SessionHostLoadBalancingAlgorithm

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

Sku
SkuTier

Esse campo deve 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 de HostPool para área de trabalho.

Name Type Description
BYODesktop
  • string

Os usuários atribuem seus próprios computadores, a lógica de balanceamento de carga permanece a mesma que a pessoal. PersonalDesktopAssignmentType deve ser direto.

Personal
  • string

Os usuários receberão um SessionHost por administradores (PersonalDesktopAssignmentType = Direct) ou na conexão com o pool (PersonalDesktopAssignmentType = Automatic). Eles serão sempre redirecionados para seus SessionHost atribuídos.

Pooled
  • string

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

Identity

Name Type Description
principalId
  • string

A ID da entidade de segurança da 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 mercado de dados.

promotionCode
  • string

Um Publicador forneceu um código de promoção como provisionado no mercado de dados para o produto/artefato citado.

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

Dimensionando referência de plano para hostpool.

Name Type Description
hostPoolArmPath
  • string

Caminho do ARM do hostpool referenciado.

scalingPlanEnabled
  • boolean

O plano de dimensionamento está habilitado para este 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 cabeçalho de acordo com a Convenção de eTag normal. Marcas de entidade são usadas para comparar duas ou mais entidades do mesmo recurso solicitado. O HTTP/1.1 usa marcas de entidade na ETag (seção 14,19), If-Match (seção 14,24), os campos de cabeçalho If-None-Match (seção 14,26) e If-Range (seção 14,27).

id
  • string

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

identity
kind
  • string

Metadados usados por portal/ferramentas/etc para renderizar experiências de UX diferentes para recursos do mesmo tipo; por exemplo, ApiApps são um tipo de tipo Microsoft. Web/sites. Se houver 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 este recurso é gerenciado por outro recurso do Azure. Se estiver presente, a implantação do 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 do usuário.

properties.hostPoolReferences

Lista de definições de ScalingHostPoolReference.

properties.hostPoolType

Tipo de HostPool para área de trabalho.

properties.objectId
  • string

ObjectId do plano de dimensionamento. (uso interno)

properties.ring
  • integer

O número de anel do plano de dimensionamento.

properties.schedules

Lista de definições de ScalingSchedule.

properties.timeZone
  • string

Fuso horário do plano de dimensionamento.

sku
tags
  • object

Marcas de recurso.

type
  • string

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

ScalingPlanPatch

Dimensionando Propriedades do plano que podem ser corrigidas.

Name Type Description
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 do usuário.

properties.hostPoolReferences

Lista de definições de ScalingHostPoolReference.

properties.hostPoolType

Tipo de HostPool para área de trabalho.

properties.ring
  • integer

O número de anel do plano de dimensionamento.

properties.schedules

Lista de definições de ScalingSchedule.

properties.timeZone
  • string

Fuso horário do plano de dimensionamento.

tags
  • object

marcas a serem atualizadas

ScalingSchedule

Agenda do plano de dimensionamento.

Name Type Description
daysOfWeek
  • string[]

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

name
  • string

Nome do agendamento de dimensionamento.

offPeakLoadBalancingAlgorithm

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

offPeakStartTime
  • string

Hora de início do período de fora de 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 de modo forçado dos hosts.

rampDownLoadBalancingAlgorithm

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

rampDownMinimumHostsPct
  • integer

Porcentagem mínima do 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 a aguardar para parar os hosts durante o período de rampa.

rampUpCapacityThresholdPct
  • integer

Limite de capacidade para o período de rampa.

rampUpLoadBalancingAlgorithm

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

rampUpMinimumHostsPct
  • integer

Porcentagem mínima do host para o período de rampa.

rampUpStartTime
  • string

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

SessionHostLoadBalancingAlgorithm

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

Name Type Description
BreadthFirst
  • string
DepthFirst
  • string

Sku

Name Type Description
capacity
  • integer

Se a SKU der suporte a scale out/in, o inteiro de capacidade deverá ser incluído. Se scale out/in não for possível para o recurso, isso pode ser omitido.

family
  • string

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

name
  • string

O nome da SKU. Ex-P3. Normalmente, é uma letra + código numérico

size
  • string

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

tier

Esse campo deve 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 deve 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