Поделиться через


Api Management Skus - List

Возвращает список SKU Microsoft.ApiManagement, доступных для вашей подписки.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/skus?api-version=2021-08-01

Параметры URI

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

string

Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True

string

Версия API для использования с клиентским запросом.

Ответы

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

ApiManagementSkusResult

ОК

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Lists all available Resource SKUs

Образец запроса

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.ApiManagement/skus?api-version=2021-08-01

Пример ответа

{
  "value": [
    {
      "resourceType": "service",
      "name": "Developer",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "None"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Standard",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 4,
        "default": 1,
        "scaleType": "Automatic"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Premium",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 10,
        "default": 1,
        "scaleType": "Automatic"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Basic",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 2,
        "default": 1,
        "scaleType": "Manual"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Consumption",
      "locations": [
        "centralindia"
      ],
      "locationInfo": [
        {
          "location": "centralindia",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 0,
        "maximum": 0,
        "default": 0,
        "scaleType": "None"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Developer",
      "locations": [
        "uaenorth"
      ],
      "locationInfo": [
        {
          "location": "uaenorth",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "None"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Standard",
      "locations": [
        "uaenorth"
      ],
      "locationInfo": [
        {
          "location": "uaenorth",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 4,
        "default": 1,
        "scaleType": "Automatic"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Premium",
      "locations": [
        "uaenorth"
      ],
      "locationInfo": [
        {
          "location": "uaenorth",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 10,
        "default": 1,
        "scaleType": "Automatic"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Basic",
      "locations": [
        "uaenorth"
      ],
      "locationInfo": [
        {
          "location": "uaenorth",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 2,
        "default": 1,
        "scaleType": "Manual"
      },
      "restrictions": []
    },
    {
      "resourceType": "service",
      "name": "Developer",
      "locations": [
        "australiacentral"
      ],
      "locationInfo": [
        {
          "location": "australiacentral",
          "zones": [],
          "zoneDetails": []
        }
      ],
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "None"
      },
      "restrictions": []
    }
  ]
}

Определения

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

Описывает доступный номер SKU ApiManagement.

ApiManagementSkuCapabilities

Описывает объект возможностей SKU.

ApiManagementSkuCapacity

Описывает сведения о масштабировании номера SKU.

ApiManagementSkuCapacityScaleType

Тип масштабирования, применимый к SKU.

ApiManagementSkuCosts

Описывает метаданные для получения сведений о ценах.

ApiManagementSkuLocationInfo
ApiManagementSkuRestrictionInfo
ApiManagementSkuRestrictions

Описывает сведения о масштабировании номера SKU.

ApiManagementSkuRestrictionsReasonCode

Причина ограничения.

ApiManagementSkuRestrictionsType

Тип ограничений.

ApiManagementSkusResult

Ответ операции перечисления ресурсов skus.

ApiManagementSkuZoneDetails

Описание зональных возможностей номера SKU.

ErrorFieldContract

Контракт поля ошибки.

ErrorResponse

Ответ на ошибку.

ApiManagementSku

Описывает доступный номер SKU ApiManagement.

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

string[]

Версии API, поддерживающие этот номер SKU.

capabilities

ApiManagementSkuCapabilities[]

Пара значений имени для описания возможности.

capacity

ApiManagementSkuCapacity

Указывает количество виртуальных машин в масштабируемом наборе.

costs

ApiManagementSkuCosts[]

Метаданные для получения сведений о ценах.

family

string

Семейство конкретного номера SKU.

kind

string

Тип ресурсов, поддерживаемых в этом номере SKU.

locationInfo

ApiManagementSkuLocationInfo[]

Список расположений и зон доступности в тех расположениях, где доступен номер SKU.

locations

string[]

Набор расположений, в которые доступен номер SKU.

name

string

Имя номера SKU.

resourceType

string

Тип ресурса, к которому применяется номер SKU.

restrictions

ApiManagementSkuRestrictions[]

Ограничения, из-за которых нельзя использовать номер SKU. Этот параметр пуст, если нет ограничений.

size

string

Размер номера SKU.

tier

string

Указывает уровень виртуальных машин в масштабируемом наборе.

Возможные значения:

Standard Edition

Основной

ApiManagementSkuCapabilities

Описывает объект возможностей SKU.

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

string

Инвариант для описания функции.

value

string

Инвариант, если признак измеряется по количеству.

ApiManagementSkuCapacity

Описывает сведения о масштабировании номера SKU.

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

integer

Емкость по умолчанию.

maximum

integer

Максимальная емкость, которую можно задать.

minimum

integer

Минимальная емкость.

scaleType

ApiManagementSkuCapacityScaleType

Тип масштабирования, применимый к SKU.

ApiManagementSkuCapacityScaleType

Тип масштабирования, применимый к SKU.

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

string

Manual

string

None

string

ApiManagementSkuCosts

Описывает метаданные для получения сведений о ценах.

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

string

Инвариант для отображения расширенной единицы измерения.

meterID

string

Используется для запроса цены из коммерческой модели.

quantity

integer

Множитель необходим для расширения базовой лимитной стоимости.

ApiManagementSkuLocationInfo

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

string

Расположение номера SKU

zoneDetails

ApiManagementSkuZoneDetails[]

Сведения о возможностях, доступных для номера SKU в определенных зонах.

zones

string[]

Список зон доступности, в которых поддерживается номер SKU.

ApiManagementSkuRestrictionInfo

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

string[]

Расположения, в которых ограничен номер SKU

zones

string[]

Список зон доступности, в которых SKU ограничен.

ApiManagementSkuRestrictions

Описывает сведения о масштабировании номера SKU.

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

ApiManagementSkuRestrictionsReasonCode

Причина ограничения.

restrictionInfo

ApiManagementSkuRestrictionInfo

Сведения об ограничении, в котором нельзя использовать номер SKU.

type

ApiManagementSkuRestrictionsType

Тип ограничений.

values

string[]

Значение ограничений. Значение , если для типа ограничения задано значение location. Это будут разные расположения, в которых SKU ограничен.

ApiManagementSkuRestrictionsReasonCode

Причина ограничения.

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

string

QuotaId

string

ApiManagementSkuRestrictionsType

Тип ограничений.

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

string

Zone

string

ApiManagementSkusResult

Ответ операции перечисления ресурсов skus.

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

string

Универсальный код ресурса (URI) для получения следующей страницы номеров SKU ресурсов. Вызовите ListNext() с этим URI, чтобы получить следующую страницу SKU ресурсов.

value

ApiManagementSku[]

Список номеров SKU, доступных для подписки.

ApiManagementSkuZoneDetails

Описание зональных возможностей номера SKU.

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

ApiManagementSkuCapabilities[]

Список возможностей, доступных для номера SKU в указанном списке зон.

name

string[]

Набор зон, в которые доступен номер SKU с указанными возможностями.

ErrorFieldContract

Контракт поля ошибки.

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

string

Код ошибки уровня свойства.

message

string

Понятное представление ошибки на уровне свойств.

target

string

Имя свойства.

ErrorResponse

Ответ на ошибку.

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

string

Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.

error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.

error.message

string

Читаемое представление ошибки.