Labs - List By Subscription

  • Ссылка
Service:
Dev Test Labs
API Version:
2018-09-15

Вывод списка лабораторий в подписке.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs?api-version=2018-09-15
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
 path True

string

Идентификатор подписки.
api-version
 query True

string

Версия API клиента.
$expand
 query

string

Укажите запрос $expand. Пример: 'properties($select=defaultStorageAccount)'
$filter
 query

string

Фильтр, применяемый к операции. Пример: '$filter=contains(name;'myName')
$orderby
 query

string

Упорядоченное выражение для результатов с использованием нотации OData. Пример: "$orderby=name desc"
$top
 query

integer

int32

Максимальное количество ресурсов, возвращаемых операцией. Пример: "$top=10"

Ответы

Имя Тип Описание
200 OK

LabList

ОК
Other Status Codes

CloudError

BadRequest

Безопасность

azure_auth

Неявное предоставление OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
user_impersonation Доступ к Microsoft Azure

Примеры

Labs_ListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs?api-version=2018-09-15

Sample Response

Status code:
200 
{
  "value": [
    {
      "properties": {
        "defaultStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}",
        "defaultPremiumStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}",
        "artifactsStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}",
        "premiumDataDiskStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/{storageAccountName}",
        "vaultName": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/{keyVaultName}",
        "labStorageType": "Premium",
        "mandatoryArtifactsResourceIdsLinux": [],
        "mandatoryArtifactsResourceIdsWindows": [],
        "createdDate": "2018-09-30T08:38:13.1973609-07:00",
        "premiumDataDisks": "Disabled",
        "environmentPermission": "Reader",
        "announcement": {
          "title": "",
          "markdown": "",
          "enabled": "Disabled",
          "expired": false
        },
        "support": {
          "enabled": "Disabled",
          "markdown": ""
        },
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName1}",
      "name": "{labName1}",
      "type": "Microsoft.DevTestLab/labs",
      "location": "westcentralus",
      "tags": {
        "tagName1": "tagValue1"
      }
    },
    {
      "properties": {
        "defaultStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName2}/providers/Microsoft.Storage/storageAccounts/{storageAccountName2}",
        "defaultPremiumStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName2}/providers/Microsoft.Storage/storageAccounts/{storageAccountName2}",
        "artifactsStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName2}/providers/Microsoft.Storage/storageAccounts/{storageAccountName2}",
        "premiumDataDiskStorageAccount": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName2}/providers/Microsoft.Storage/storageAccounts/{storageAccountName2}",
        "vaultName": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName2}/providers/Microsoft.KeyVault/vaults/{keyVaultName2}",
        "labStorageType": "Premium",
        "mandatoryArtifactsResourceIdsLinux": [],
        "mandatoryArtifactsResourceIdsWindows": [],
        "createdDate": "2018-09-30T09:37:52.9675083-07:00",
        "premiumDataDisks": "Disabled",
        "environmentPermission": "Reader",
        "announcement": {
          "title": "",
          "markdown": "",
          "enabled": "Disabled",
          "expired": false
        },
        "support": {
          "enabled": "Disabled",
          "markdown": ""
        },
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName2}/providers/microsoft.devtestlab/labs/{labName2}",
      "name": "{labName2}",
      "type": "Microsoft.DevTestLab/labs",
      "location": "japaneast",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Определения

Имя Описание
CloudError

Ошибка из запроса REST.
CloudErrorBody

Текст ошибки из запроса REST.
EnableStatus

Состояние расписания (т. е. "Включено", "Отключено")
EnvironmentPermission

Права доступа, предоставляемые пользователю при подготовке среды
Lab

Лаборатория.
LabAnnouncementProperties

Свойства баннера объявления лаборатории
LabList

Ответ операции со списком.
LabSupportProperties

Свойства баннера поддержки лаборатории
PremiumDataDisk

Параметр для включения использования дисков данных уровня "Премиум". Если его значение равно "Включено", создание дисков данных уровня "Стандартный" или "Премиум" разрешено. Если его значение равно "Отключено", допускается только создание стандартных дисков данных.
StorageType

Тип хранилища для диска (например, "Стандартный", "Премиум").

CloudError

Ошибка из запроса REST.

Имя Тип Описание
error

CloudErrorBody

Произошла облачная ошибка

CloudErrorBody

Текст ошибки из запроса REST.

Имя Тип Описание
code

string

Код ошибки.
details

CloudErrorBody[]

Внутренние ошибки.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

EnableStatus

Состояние расписания (т. е. "Включено", "Отключено")

Имя Тип Описание
Disabled

string

Enabled

string

EnvironmentPermission

Права доступа, предоставляемые пользователю при подготовке среды

Имя Тип Описание
Contributor

string

Reader

string

Lab

Лаборатория.

Имя Тип Значение по умолчанию Описание
id

string

Идентификатор ресурса.
location

string

Расположение ресурса.
name

string

Имя ресурса.
properties.announcement

LabAnnouncementProperties

Свойства любого объявления лаборатории, связанного с этой лабораторией
properties.artifactsStorageAccount

string

Учетная запись хранения артефактов лаборатории.
properties.createdDate

string

Дата создания лаборатории.
properties.defaultPremiumStorageAccount

string

Учетная запись хранения класса Premium по умолчанию для лаборатории.
properties.defaultStorageAccount

string

Учетная запись хранения лаборатории по умолчанию.
properties.environmentPermission

EnvironmentPermission

Права доступа, предоставляемые пользователю при подготовке среды
properties.extendedProperties

object

Расширенные свойства лаборатории, используемые для экспериментальных функций
properties.labStorageType

StorageType

Premium

Тип хранилища, используемого лабораторией. Это может быть категория "Премиум" или "Стандартный". Значение по умолчанию — Premium.
properties.loadBalancerId

string

Подсистема балансировки нагрузки, используемая для виртуальных машин лаборатории, использующих общий IP-адрес.
properties.mandatoryArtifactsResourceIdsLinux

string[]

Упорядоченный список идентификаторов ресурсов артефактов, которые должны применяться ко всем созданным виртуальным машинам Linux по умолчанию до артефактов, указанных пользователем.
properties.mandatoryArtifactsResourceIdsWindows

string[]

Упорядоченный список идентификаторов ресурсов артефактов, которые должны применяться ко всем созданиям виртуальных машин Windows по умолчанию до артефактов, указанных пользователем.
properties.networkSecurityGroupId

string

Группа безопасности сети, подключенная к сетевым интерфейсам виртуальных машин лаборатории для ограничения открытых портов.
properties.premiumDataDiskStorageAccount

string

Учетная запись хранения диска данных класса Premium лаборатории.
properties.premiumDataDisks

PremiumDataDisk

Параметр для включения использования дисков данных уровня "Премиум". Если его значение равно "Включено", создание дисков данных уровня "Стандартный" или "Премиум" разрешено. Если его значение равно "Отключено", допускается только создание стандартных дисков данных.
properties.provisioningState

string

Состояние подготовки ресурса.
properties.publicIpId

string

Общедоступный IP-адрес подсистемы балансировки нагрузки лаборатории.
properties.support

LabSupportProperties

Свойства любого сообщения о поддержке лаборатории, связанного с этой лабораторией
properties.uniqueIdentifier

string

Уникальный неизменяемый идентификатор ресурса (Guid).
properties.vaultName

string

Хранилище ключей лаборатории.
properties.vmCreationResourceGroup

string

Группа ресурсов, в которой будут созданы все новые виртуальные машины лаборатории. Чтобы позволить DevTest Labs управлять созданием группы ресурсов, присвойте этому значению значение NULL.
tags

object

Теги ресурса.
type

string

Тип ресурса.

LabAnnouncementProperties

Свойства баннера объявления лаборатории

Имя Тип Описание
enabled

EnableStatus

Объявление о лаборатории активно или включено в настоящее время?
expirationDate

string

Время истечения срока действия объявления (null для никогда)
expired

boolean

Истек срок действия этого объявления?
markdown

string

Текст Markdown (если таковой есть), отображаемый в пользовательском интерфейсе в этом задании. Если оставить пустым или null, ничего не будет отображаться.
provisioningState

string

Состояние подготовки ресурса.
title

string

Заголовок в виде обычного текста для объявления лаборатории
uniqueIdentifier

string

Уникальный неизменяемый идентификатор ресурса (Guid).

LabList

Ответ операции со списком.

Имя Тип Описание
nextLink

string

Ссылка для следующего набора результатов.
value

Lab[]

Результаты операции со списком.

LabSupportProperties

Свойства баннера поддержки лаборатории

Имя Тип Описание
enabled

EnableStatus

В настоящее время ли баннер поддержки лаборатории активен или включен?
markdown

string

Текст Markdown (если таковой есть), отображаемый в пользовательском интерфейсе в этом задании. Если оставить пустым или null, ничего не будет отображаться.

PremiumDataDisk

Параметр для включения использования дисков данных уровня "Премиум". Если его значение равно "Включено", создание дисков данных уровня "Стандартный" или "Премиум" разрешено. Если его значение равно "Отключено", допускается только создание стандартных дисков данных.

Имя Тип Описание
Disabled

string

Enabled

string

StorageType

Тип хранилища для диска (например, "Стандартный", "Премиум").

Имя Тип Описание
Premium

string

Standard

string

StandardSSD

string