Scaling Plans - List By Subscription

Referência

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

Listar planos de dimensionamento na subscrição.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	ScalingPlanList	Os planos de dimensionamento foram obtidos com êxito na subscrição.
Other Status Codes	CloudError	Resposta de erro de automatização que descreve o motivo pela qual 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

Name	Description
CloudError	Objeto de erro de cloud.
CloudErrorProperties	Propriedades do objeto de erro da cloud.
createdByType	O tipo de identidade que criou o recurso.
DaysOfWeek	Conjunto de dias da semana em que esta agenda está ativa.
Identity
Plan
ResourceIdentityType	O tipo de identidade.
ScalingHostPoolReference	Referência do plano de dimensionamento para o conjunto de anfitriões.
ScalingHostPoolType	Tipo de conjunto de anfitriões para ambiente de trabalho.
ScalingPlan	ScalingPlan
ScalingPlanList	ScalingPlanList
ScalingSchedule	Agenda do plano de dimensionamento.
SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de aumento.
Sku
SkuTier	Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.
StopHostsWhen	Especifica quando parar anfitriões durante o período de inatividade da rampa.
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 cloud.

Name	Tipo	Description
error	CloudErrorProperties	Propriedades do objeto de erro da cloud.

CloudErrorProperties

Propriedades do objeto de erro da cloud.

Name	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DaysOfWeek

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

Name	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Identity

Name	Tipo	Description
principalId	string	O ID principal da identidade do recurso.
tenantId	string	O ID de inquilino do recurso.
type	ResourceIdentityType	O tipo de identidade.

Plan

Name	Tipo	Description
name	string	Um nome definido pelo utilizador do Artefacto de Terceiros que está a ser obtido.
product	string	O artefacto de terceiros que está a ser obtido. Por exemplo, NewRelic. O produto mapeia para o OfferID especificado para o artefacto no momento da integração do Mercado de Dados.
promotionCode	string	Um editor forneceu código de promoção conforme aprovisionado no Mercado de Dados para o referido produto/artefacto.
publisher	string	O editor do Artefacto de Terceiros que está a ser comprado. Por exemplo, NewRelic
version	string	A versão do produto/artefacto pretendido.

ResourceIdentityType

O tipo de identidade.

Name	Tipo	Description
SystemAssigned	string

ScalingHostPoolReference

Referência do plano de dimensionamento para o conjunto de anfitriões.

Name	Tipo	Description
hostPoolArmPath	string	Caminho do arm do conjunto de anfitriões referenciado.
scalingPlanEnabled	boolean	O plano de dimensionamento está ativado para este conjunto de anfitriões.

ScalingHostPoolType

Tipo de conjunto de anfitriões para ambiente de trabalho.

Name	Tipo	Description
Pooled	string	Os utilizadores obtêm um SessionHost novo (aleatório) sempre que se ligam ao HostPool.

ScalingPlan

Name	Tipo	Description
etag	string	O campo etag não é obrigatório. Se for fornecido no corpo da resposta, também tem de ser fornecido como um cabeçalho de acordo com a convenção de etag normal. As etiquetas de entidade são utilizadas para comparar duas ou mais entidades do mesmo recurso pedido. HTTP/1.1 utiliza etiquetas de entidade na 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) campos de cabeçalho.
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity
kind	string	Metadados utilizados pelo portal/ferramentas/etc. para compor diferentes experiências UX para recursos do mesmo tipo; Por exemplo, as ApiApps são uma espécie de Microsoft.Web/sites. Se for suportado, o fornecedor de recursos tem de validar e manter este valor.
location	string	A localização geográfica onde reside o recurso
managedBy	string	O ID de recurso completamente qualificado do recurso que gere este recurso. Indica se este recurso é gerido por outro recurso do Azure. Se estiver presente, a implementação do modo completo não eliminará o recurso se for removido do modelo, uma vez que é gerido por outro recurso.
name	string	O nome do recurso
plan	Plan
properties.description	string	Descrição do plano de dimensionamento.
properties.exclusionTag	string	Etiqueta de exclusão para o plano de dimensionamento.
properties.friendlyName	string	Nome amigável do utilizador do plano de dimensionamento.
properties.hostPoolReferences	ScalingHostPoolReference[]	Lista de definições scalingHostPoolReference.
properties.hostPoolType	ScalingHostPoolType	Tipo de conjunto de anfitriões para ambiente de trabalho.
properties.objectId	string	ObjectId do plano de dimensionamento. (utilização interna)
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	Etiquetas de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScalingPlanList

Name	Tipo	Description
nextLink	string	Ligar à página seguinte dos resultados.
value	ScalingPlan[]	Lista de definições do plano de dimensionamento.

ScalingSchedule

Agenda do plano de dimensionamento.

Name	Tipo	Description
daysOfWeek	DaysOfWeek[]	Conjunto de dias da semana em que esta agenda está ativa.
name	string	Nome da agenda de dimensionamento.
offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o 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	Hora de início do período de pico.
rampDownCapacityThresholdPct	integer	Limiar de capacidade para o período de redução da rampa.
rampDownForceLogoffUsers	boolean	Caso os utilizadores sejam iniciados com força a partir de anfitriões.
rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de redução da rampa.
rampDownMinimumHostsPct	integer	Percentagem mínima de anfitrião para o período de redução da rampa.
rampDownNotificationMessage	string	Mensagem de notificação para utilizadores durante o período de arranque.
rampDownStartTime	Time	Hora de início do período de inatividade da rampa.
rampDownStopHostsWhen	StopHostsWhen	Especifica quando parar anfitriões durante o período de inatividade da rampa.
rampDownWaitTimeMinutes	integer	Número de minutos a aguardar para parar os anfitriões durante o período de inatividade da rampa.
rampUpCapacityThresholdPct	integer	Limiar de capacidade para o período de aumento.
rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de aumento.
rampUpMinimumHostsPct	integer	Percentagem mínima de anfitrião para o período de aumento.
rampUpStartTime	Time	Hora de início do período de arranque.

SessionHostLoadBalancingAlgorithm

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

Name	Tipo	Description
BreadthFirst	string
DepthFirst	string

Sku

Name	Tipo	Description
capacity	integer	Se o SKU suportar o aumento/aumento horizontal, o número inteiro da capacidade deve ser incluído. Se não for possível aumentar/reduzir horizontalmente para o recurso, tal poderá ser omitido.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do SKU. Ex - P3. Normalmente, é um código letter+number
size	string	O tamanho do SKU. Quando o campo de nome é a combinação de camada e outro valor, este seria o código autónomo.
tier	SkuTier	Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.

SkuTier

Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.

Name	Tipo	Description
Basic	string
Free	string
Premium	string
Standard	string

StopHostsWhen

Especifica quando parar anfitriões durante o período de inatividade da rampa.

Name	Tipo	Description
ZeroActiveSessions	string
ZeroSessions	string

systemData

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

Name	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.

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