Scaling Plans - List By Subscription

Referência

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

Listar planos de dimensionamento na assinatura.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans?api-version=2022-02-10-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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

Nome	Tipo	Description
200 OK	ScalingPlanList	Planos de dimensionamento recuperados com êxito na assinatura.
Other Status Codes	CloudError	Resposta de erro de automação que descreve por que a operação falhou.

Exemplos

ScalingPlans_ListBySubscription

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

package armdesktopvirtualization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2022-02-10-preview/examples/ScalingPlan_ListBySubscription.json
func ExampleScalingPlansClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdesktopvirtualization.NewScalingPlansClient("daefabc0-95b4-48b3-b645-8a753a63c4fa", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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"
      },
      "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
          }
        ]
      }
    },
    {
      "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"
      },
      "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": false,
            "rampDownStopHostsWhen": "ZeroActiveSessions",
            "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 esse agendamento está ativo.
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
ScalingPlanList	ScalingPlanList
ScalingSchedule	Agendamento do plano de dimensionamento.
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 ramp down.
systemData	Metadados relativos à criação e à última modificação do recurso.
Time	O tempo para uma ação de dimensionamento ocorrer.

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 do 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 esse agendamento está ativo.

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.
tenantId	string	A ID do locatário do recurso.
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 o OfferID especificado para o artefato no momento da integração do Mercado de Dados.
promotionCode	string	Um editor forneceu código de promoção conforme provisionado no Mercado de Dados para o produto/artefato dito.
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 esse hostpool.

ScalingHostPoolType

Tipo de HostPool para área de trabalho.

Nome	Tipo	Description
Pooled	string	Os usuários recebem uma nova SessionHost (aleatória) sempre que ela se conecta ao HostPool.

ScalingPlan

Nome	Tipo	Description
etag	string	O campo de etag não é necessário. Se ele 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 campos de cabeçalho 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	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 uma espécie 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 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	Tipo de HostPool para área de trabalho.
properties.objectId	string	ObjectId do plano de dimensionamento. (uso interno)
properties.schedules	ScalingSchedule[]	Lista de definições scalingSchedule.
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	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScalingPlanList

Nome	Tipo	Description
nextLink	string	Link para a próxima página de resultados.
value	ScalingPlan[]	Lista de definições de plano de dimensionamento.

ScalingSchedule

Agendamento do plano de dimensionamento.

Nome	Tipo	Description
daysOfWeek	DaysOfWeek[]	Conjunto de dias da semana em que esse agendamento está ativo.
name	string	Nome do agendamento de dimensionamento.
offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para um período fora do pico.
offPeakStartTime	Time	Hora de início do período fora do pico.
peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de pico.
peakStartTime	Time	Horário de início do período de pico.
rampDownCapacityThresholdPct	integer	Limite de capacidade para o período de aceleração.
rampDownForceLogoffUsers	boolean	Os usuários devem ser desconectados com força dos hosts.
rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de ramp down.
rampDownMinimumHostsPct	integer	Percentual mínimo de host para o período de aceleração.
rampDownNotificationMessage	string	Mensagem de notificação para usuários durante o período de ramp down.
rampDownStartTime	Time	Hora de início do período de rampa para baixo.
rampDownStopHostsWhen	StopHostsWhen	Especifica quando parar os hosts durante o período de ramp down.
rampDownWaitTimeMinutes	integer	Número de minutos de espera para interromper os hosts durante o período de ramp down.
rampUpCapacityThresholdPct	integer	Limite de capacidade para o período de aumento.
rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para aumentar o período.
rampUpMinimumHostsPct	integer	Percentual mínimo de host para o período de aumento.
rampUpStartTime	Time	Hora de início do 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 o scale out/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. 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	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 ramp down.

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 uma ação de dimensionamento ocorrer.

Nome	Tipo	Description
hour	integer	A hora.
minute	integer	O minuto.