Compartilhar via

Scaling Plans - Get

  • Referência
Serviço:
Desktop Virtualization
Versão da API:
2024-04-03

Obtenha um plano de dimensionamento.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}?api-version=2024-04-03

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
scalingPlanName
 path True

string

O nome do plano de dimensionamento.

Padrão Regex: ^[A-Za-z0-9@.\-_ ]*$
subscriptionId
 path True

string

uuid

A ID da assinatura de destino. O valor deve ser uma UUID.
api-version
 query True

string

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

Respostas

Nome Tipo Description
200 OK

ScalingPlan

Plano de dimensionamento recuperado com êxito.
Other Status Codes

CloudError

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

Exemplos

ScalingPlans_Get

Solicitação de exemplo

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1?api-version=2024-04-03

Resposta de exemplo

Código de status:
200 
{
  "name": "workspace1",
  "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"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "objectId": "00000000-0000-0000-0000-000000000000",
    "description": "Description of scaling plan",
    "friendlyName": "Scaling Plan 1",
    "timeZone": "Central Standard Time",
    "hostPoolType": "Pooled",
    "exclusionTag": "value",
    "schedules": [
      {
        "name": "schedule1",
        "daysOfWeek": [
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday"
        ],
        "rampUpStartTime": {
          "hour": 6,
          "minute": 0
        },
        "rampUpLoadBalancingAlgorithm": "DepthFirst",
        "rampUpMinimumHostsPct": 20,
        "rampUpCapacityThresholdPct": 80,
        "peakStartTime": {
          "hour": 8,
          "minute": 0
        },
        "peakLoadBalancingAlgorithm": "BreadthFirst",
        "rampDownStartTime": {
          "hour": 18,
          "minute": 0
        },
        "rampDownLoadBalancingAlgorithm": "DepthFirst",
        "rampDownMinimumHostsPct": 20,
        "rampDownCapacityThresholdPct": 50,
        "rampDownForceLogoffUsers": true,
        "rampDownWaitTimeMinutes": 30,
        "rampDownNotificationMessage": "message",
        "offPeakStartTime": {
          "hour": 20,
          "minute": 0
        },
        "offPeakLoadBalancingAlgorithm": "DepthFirst"
      }
    ],
    "hostPoolReferences": [
      {
        "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
        "scalingPlanEnabled": true
      }
    ]
  }
}

Definições

Nome Description
CloudError

Objeto de erro de nuvem.
CloudErrorProperties

Propriedades do objeto de erro de nuvem.
createdByType

O tipo de identidade que criou o recurso.
DaysOfWeek

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

O tipo de identidade.
ScalingHostPoolReference

Referência de plano de dimensionamento para hostpool.
ScalingHostPoolType

Tipo de HostPool para área de trabalho.
ScalingPlan

ScalingPlan
ScalingSchedule

Um ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm

Algoritmo de balanceamento de carga para aumentar o período.
Sku
SkuTier

Esse campo deverá 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 os hosts durante o período de rampa para baixo.
systemData

Metadados relativos à criação e última modificação do recurso.
Time

O tempo para que uma ação de dimensionamento ocorra.

CloudError

Objeto de erro de nuvem.

Nome Tipo Description
error

CloudErrorProperties

Propriedades do objeto de erro de nuvem.

CloudErrorProperties

Propriedades do objeto de erro de nuvem.

Nome Tipo Description
code

string

Código de erro
message

string

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

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

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

Nome Tipo Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

Identity

Nome Tipo Description
principalId

string

A ID principal da identidade do recurso. O valor deve ser uma UUID.
tenantId

string

A ID do locatário do recurso. O valor deve ser uma UUID.
type

ResourceIdentityType

O tipo de identidade.

Plan

Nome Tipo 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 exemplo, NewRelic. O produto é mapeado para a OfferID especificada para o artefato no momento da integração do Mercado de Dados.
promotionCode

string

Um editor forneceu código de promoção como provisionado no Mercado de Dados para o produto/artefato.
publisher

string

O editor do Artefato de Terceiros que está sendo comprado. Por exemplo, NewRelic
version

string

A versão do produto/artefato desejado.

ResourceIdentityType

O tipo de identidade.

Nome Tipo Description
SystemAssigned

string

ScalingHostPoolReference

Referência de plano de dimensionamento para hostpool.

Nome Tipo Description
hostPoolArmPath

string

Caminho do braço do hostpool referenciado.
scalingPlanEnabled

boolean

O plano de dimensionamento está habilitado para este hostpool.

ScalingHostPoolType

Tipo de HostPool para área de trabalho.

Nome Tipo Description
Pooled

string

Os usuários obtêm um SessionHost novo (aleatório) sempre que ele se conecta ao HostPool.

ScalingPlan

ScalingPlan

Nome Tipo Valor padrão Description
etag

string

O campo de 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. As marcas de entidade são usadas para comparar duas ou mais entidades do mesmo recurso solicitado. HTTP/1.1 usa marcas de entidade na 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 exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

Identity

kind

string

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

string

A localização geográfica onde 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 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

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

ScalingHostPoolReference[]

Lista de definições scalingHostPoolReference.
properties.hostPoolType

ScalingHostPoolType

Pooled

Tipo de HostPool para área de trabalho.
properties.objectId

string

ObjectId do plano de dimensionamento. (uso interno)
properties.schedules

ScalingSchedule[]

Lista de definições scalingPlanPooledSchedule.
properties.timeZone

string

Fuso horário do plano de dimensionamento.
sku

Sku

systemData

systemData

Metadados relativos à criação e última modificação do recurso.
tags

object

Marcas de recurso.
type

string

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

ScalingSchedule

Um ScalingPlanPooledSchedule.

Nome Tipo Description
daysOfWeek

DaysOfWeek[]

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

string

Nome do ScalingPlanPooledSchedule.
offPeakLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm

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

Time

Tempo de início para o período fora do pico.
peakLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm

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

Time

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

integer

Limite de capacidade para o período de rampa para baixo.
rampDownForceLogoffUsers

boolean

Caso os usuários sejam retirados com força dos hosts.
rampDownLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm

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

integer

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

string

Mensagem de notificação para usuários durante o período de ramp down.
rampDownStartTime

Time

Tempo de partida para o período de rampa para baixo.
rampDownStopHostsWhen

StopHostsWhen

Especifica quando parar os hosts durante o período de rampa para baixo.
rampDownWaitTimeMinutes

integer

Número de minutos para aguardar para interromper os hosts durante o período de rampa para baixo.
rampUpCapacityThresholdPct

integer

Limite de capacidade para aumentar o período.
rampUpLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm

Algoritmo de balanceamento de carga para aumentar o período.
rampUpMinimumHostsPct

integer

Percentual mínimo de host para aumentar o período.
rampUpStartTime

Time

Tempo de início para o período de aumento.

SessionHostLoadBalancingAlgorithm

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

Nome Tipo Description
BreadthFirst

string

DepthFirst

string

Sku

Nome Tipo Description
capacity

integer

Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se a escala horizontal/in não for possível para o recurso, isso poderá 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. Por exemplo, P3. Normalmente, é um código letter+number
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

SkuTier

Esse campo deverá 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 deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

Nome Tipo Description
Basic

string

Free

string

Premium

string

Standard

string

StopHostsWhen

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

Nome Tipo Description
ZeroActiveSessions

string

ZeroSessions

string

systemData

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

Time

O tempo para que uma ação de dimensionamento ocorra.

Nome Tipo Description
hour

integer

A hora.
minute

integer

O minuto.