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


Cloud Services - List

Возвращает список всех облачных служб в группе ресурсов. Используйте свойство nextLink в ответе, чтобы получить следующую страницу Облачные службы. Делайте это, пока nextLink не будет иметь значение NULL, чтобы получить все Облачные службы.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices?api-version=2022-09-04

Параметры URI

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

string

Имя группы ресурсов.

subscriptionId
path True

string

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

api-version
query True

string

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

Ответы

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

CloudServiceListResult

ОК

Other Status Codes

CloudError

Ошибка

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

List Cloud Services in a Resource Group

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

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices?api-version=2022-09-04

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

{
  "value": [
    {
      "name": "{cs-name}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
      "type": "Microsoft.Compute/cloudServices",
      "location": "eastus2euap",
      "properties": {
        "configuration": "{ServiceConfiguration}",
        "upgradeMode": "Auto",
        "roleProfile": {
          "roles": [
            {
              "name": "ContosoFrontend",
              "sku": {
                "name": "Standard_D1_v2",
                "tier": "Standard",
                "capacity": 2
              }
            },
            {
              "name": "ContosoBackend",
              "sku": {
                "name": "Standard_D1_v2",
                "tier": "Standard",
                "capacity": 2
              }
            }
          ]
        },
        "osProfile": {
          "secrets": []
        },
        "networkProfile": {
          "loadBalancerConfigurations": [
            {
              "name": "contosolb",
              "properties": {
                "frontendIpConfigurations": [
                  {
                    "name": "contosofe",
                    "properties": {
                      "publicIPAddress": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
                      }
                    }
                  }
                ]
              }
            }
          ]
        },
        "extensionProfile": {
          "extensions": [
            {
              "name": "RDPExtension",
              "properties": {
                "autoUpgradeMinorVersion": false,
                "provisioningState": "Succeeded",
                "rolesAppliedTo": [
                  "*"
                ],
                "publisher": "Microsoft.Windows.Azure.Extensions",
                "type": "RDP",
                "typeHandlerVersion": "1.2",
                "settings": "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>"
              }
            }
          ]
        },
        "provisioningState": "Succeeded",
        "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
      }
    }
  ]
}

Определения

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

Ошибка API.

ApiErrorBase

База ошибок API.

CloudError

Ответ об ошибке от службы вычислений.

CloudService

Описывает облачную службу.

CloudServiceExtensionProfile

Описывает профиль расширения облачной службы.

CloudServiceExtensionProperties

Свойства расширения.

CloudServiceListResult

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

CloudServiceNetworkProfile

Профиль сети для облачной службы.

CloudServiceOsProfile

Описывает профиль ОС для облачной службы.

CloudServiceProperties

Свойства облачной службы

CloudServiceRoleProfile

Описывает профиль роли для облачной службы.

CloudServiceRoleProfileProperties

Описывает свойства роли.

CloudServiceRoleSku

Описывает номер SKU роли облачной службы.

CloudServiceSlotType

Тип слота для облачной службы. Возможные значения.

Рабочая среда

Промежуточная

Если значение не указано, значение по умолчанию — Production.

CloudServiceUpgradeMode

Режим обновления для облачной службы. При развертывании службы для обновления доменов выделяются экземпляры ролей. Обновления можно начать вручную в каждом домене обновления либо автоматически во всех доменах обновления. Возможные значения:

Автоматически

Вручную

Одновременное

Если значение не указано, значение по умолчанию — Auto. Если задано значение Вручную, необходимо вызвать метод PUT UpdateDomain, чтобы применить обновление. Если задано значение Автоматически, обновление автоматически применяется к каждому домену обновления последовательно.

CloudServiceVaultAndSecretReference

Защищенные параметры для расширения, на которые ссылается keyVault, которые шифруются перед отправкой в экземпляр роли.

CloudServiceVaultCertificate

Описывает ссылку на один сертификат в Key Vault и расположение сертификата в экземпляре роли.

CloudServiceVaultSecretGroup

Описывает набор сертификатов, которые находятся в одном Key Vault.

Extension

Описывает расширение облачной службы.

InnerError

Сведения о внутренней ошибке.

LoadBalancerConfiguration

Описывает конфигурацию подсистемы балансировки нагрузки.

LoadBalancerConfigurationProperties

Описывает свойства конфигурации подсистемы балансировки нагрузки.

LoadBalancerFrontendIpConfiguration

Указывает интерфейсный IP-адрес, используемый для подсистемы балансировки нагрузки. Поддерживается только интерфейсный IP-адрес IPv4. Каждая конфигурация подсистемы балансировки нагрузки должна иметь ровно одну интерфейсную IP-конфигурацию.

LoadBalancerFrontendIpConfigurationProperties

Описание IP-конфигурации облачной службы

SubResource
SystemData

Системные метаданные, относящиеся к этому ресурсу.

ApiError

Ошибка API.

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

string

Код ошибки.

details

ApiErrorBase[]

Сведения об ошибке API

innererror

InnerError

Внутренняя ошибка API

message

string

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

target

string

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

ApiErrorBase

База ошибок API.

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

string

Код ошибки.

message

string

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

target

string

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

CloudError

Ответ об ошибке от службы вычислений.

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

ApiError

Ошибка API.

CloudService

Описывает облачную службу.

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

string

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

location

string

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

name

string

Имя ресурса.

properties

CloudServiceProperties

Свойства облачной службы

systemData

SystemData

Системные метаданные, относящиеся к этому ресурсу.

tags

object

Теги ресурсов.

type

string

Тип ресурса.

zones

string[]

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

CloudServiceExtensionProfile

Описывает профиль расширения облачной службы.

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

Extension[]

Список расширений для облачной службы.

CloudServiceExtensionProperties

Свойства расширения.

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

boolean

Явно укажите, может ли платформа автоматически обновлять typeHandlerVersion до более поздних дополнительных версий, когда они станут доступны.

forceUpdateTag

string

Тег для принудительного применения предоставленных общедоступных и защищенных параметров. Изменение значения тега позволяет повторно запустить расширение без изменения каких-либо общедоступных или защищенных параметров. Если параметр forceUpdateTag не изменен, обработчик по-прежнему будет применять обновления общедоступных или защищенных параметров. Если ни forceUpdateTag, ни какие-либо из общедоступных или защищенных параметров не изменяются, расширение будет передаваться экземпляру роли с тем же порядковой номером, и реализация обработчика будет решать, следует ли повторно запустить его или нет.

protectedSettings

object

Защищенные параметры для расширения, которые шифруются перед отправкой в экземпляр роли.

protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

Защищенные параметры для расширения, на которые ссылается keyVault, которые шифруются перед отправкой в экземпляр роли.

provisioningState

string

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

publisher

string

Имя издателя обработчика расширений.

rolesAppliedTo

string[]

Необязательный список ролей для применения этого расширения. Если свойство не указано или указано "*", расширение применяется ко всем ролям в облачной службе.

settings

object

Общедоступные параметры расширения. Для расширений JSON это параметры JSON для расширения. Для расширения XML (например, RDP) это параметр XML для расширения.

type

string

Указывает тип расширения.

typeHandlerVersion

string

Указывает версию расширения. Указывает версию расширения. Если этот элемент не указан или в качестве значения используется звездочка (*), используется последняя версия расширения. Если значение указано с номером основной версии и звездочкой в качестве дополнительного номера версии (X.), выбирается последняя дополнительная версия указанной основной версии. Если указаны основной номер версии и дополнительный номер версии (X.Y), выбирается конкретная версия расширения. Если указана версия, выполняется автоматическое обновление экземпляра роли.

CloudServiceListResult

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

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

string

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

value

CloudService[]

Список ресурсов.

CloudServiceNetworkProfile

Профиль сети для облачной службы.

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

LoadBalancerConfiguration[]

Список конфигураций подсистемы балансировки нагрузки. Облачная служба может иметь до двух конфигураций подсистемы балансировки нагрузки, соответствующих общедоступной Load Balancer и внутренней Load Balancer.

slotType

CloudServiceSlotType

Тип слота для облачной службы. Возможные значения.

Рабочая среда

Промежуточная

Если значение не указано, значение по умолчанию — Production.

swappableCloudService

SubResource

Ссылка на идентификатор облачной службы, содержащая целевой IP-адрес, с которым субъектная облачная служба может выполнить переключение. Это свойство не может быть обновлено после его установки. Должна присутствовать переключенная облачная служба, на которую ссылается этот идентификатор, в противном случае будет возникать ошибка.

CloudServiceOsProfile

Описывает профиль ОС для облачной службы.

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

CloudServiceVaultSecretGroup[]

Указывает набор сертификатов, которые должны быть установлены на экземпляры роли.

CloudServiceProperties

Свойства облачной службы

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

boolean

(Необязательно) Указывает, должны ли свойства SKU роли (roleProfile.roles.sku), указанные в модели или шаблоне, переопределять число экземпляров роли и размер виртуальной машины, указанные в файлах CSCFG и CSDEF соответственно. Значение по умолчанию — false.

configuration

string

Указывает конфигурацию СЛУЖБЫ XML (CSCFG) для облачной службы.

configurationUrl

string

Указывает URL-адрес, ссылающийся на расположение конфигурации службы в службе BLOB-объектов. URL-адрес пакета службы может быть URI подписанного URL-адреса (SAS) из любой учетной записи хранения. Это свойство доступно только для записи и не возвращается в вызовах GET.

extensionProfile

CloudServiceExtensionProfile

Описывает профиль расширения облачной службы.

networkProfile

CloudServiceNetworkProfile

Профиль сети для облачной службы.

osProfile

CloudServiceOsProfile

Описывает профиль ОС для облачной службы.

packageUrl

string

Задает URL-адрес, который указывает на расположение пакета служб в службе BLOB-объектов. URL-адрес пакета службы может быть URI подписанного URL-адреса (SAS) из любой учетной записи хранения. Это свойство доступно только для записи и не возвращается в вызовах GET.

provisioningState

string

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

roleProfile

CloudServiceRoleProfile

Описывает профиль роли для облачной службы.

startCloudService

boolean

(Необязательно) Указывает, следует ли запускать облачную службу сразу после ее создания. Значение по умолчанию — true. Если значение равно false, модель службы по-прежнему развертывается, но код выполняется не сразу. Вместо этого служба будет работать в PoweredOff, пока вы не вызовете start, и в это время служба будет запущена. За развернутую службу по-прежнему взимается плата, даже если она отключена.

uniqueId

string

Уникальный идентификатор облачной службы.

upgradeMode

CloudServiceUpgradeMode

Режим обновления для облачной службы. При развертывании службы для обновления доменов выделяются экземпляры ролей. Обновления можно начать вручную в каждом домене обновления либо автоматически во всех доменах обновления. Возможные значения:

Автоматически

Вручную

Одновременное

Если значение не указано, значение по умолчанию — Auto. Если задано значение Вручную, необходимо вызвать метод PUT UpdateDomain, чтобы применить обновление. Если задано значение Автоматически, обновление автоматически применяется к каждому домену обновления последовательно.

CloudServiceRoleProfile

Описывает профиль роли для облачной службы.

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

CloudServiceRoleProfileProperties[]

Список ролей для облачной службы.

CloudServiceRoleProfileProperties

Описывает свойства роли.

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

string

Имя ресурса.

sku

CloudServiceRoleSku

Описывает номер SKU роли облачной службы.

CloudServiceRoleSku

Описывает номер SKU роли облачной службы.

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

integer

Указывает количество экземпляров роли в облачной службе.

name

string

Имя SKU. ПРИМЕЧАНИЕ. Если новый номер SKU не поддерживается на оборудовании, на который сейчас работает облачная служба, необходимо удалить и повторно создать облачную службу или вернуться к старому номеру SKU.

tier

string

Указывает уровень облачной службы. Возможные значения:

Standard Edition

Основной

CloudServiceSlotType

Тип слота для облачной службы. Возможные значения.

Рабочая среда

Промежуточная

Если значение не указано, значение по умолчанию — Production.

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

string

Staging

string

CloudServiceUpgradeMode

Режим обновления для облачной службы. При развертывании службы для обновления доменов выделяются экземпляры ролей. Обновления можно начать вручную в каждом домене обновления либо автоматически во всех доменах обновления. Возможные значения:

Автоматически

Вручную

Одновременное

Если значение не указано, значение по умолчанию — Auto. Если задано значение Вручную, необходимо вызвать метод PUT UpdateDomain, чтобы применить обновление. Если задано значение Автоматически, обновление автоматически применяется к каждому домену обновления последовательно.

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

string

Manual

string

Simultaneous

string

CloudServiceVaultAndSecretReference

Защищенные параметры для расширения, на которые ссылается keyVault, которые шифруются перед отправкой в экземпляр роли.

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

string

URL-адрес секрета, содержащий защищенные параметры расширения

sourceVault

SubResource

Идентификатор ресурса ARM Key Vault

CloudServiceVaultCertificate

Описывает ссылку на один сертификат в Key Vault и расположение сертификата в экземпляре роли.

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

string

Это URL-адрес сертификата, который был отправлен в Key Vault в качестве секрета.

CloudServiceVaultSecretGroup

Описывает набор сертификатов, которые находятся в одном Key Vault.

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

SubResource

Относительный URL-адрес Key Vault, содержащий все сертификаты в VaultCertificates.

vaultCertificates

CloudServiceVaultCertificate[]

Список ссылок на хранилища ключей в SourceVault, которые содержат сертификаты.

Extension

Описывает расширение облачной службы.

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

string

Имя модуля.

properties

CloudServiceExtensionProperties

Свойства расширения.

InnerError

Сведения о внутренней ошибке.

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

string

Внутреннее сообщение об ошибке или дамп исключений.

exceptiontype

string

Тип исключения.

LoadBalancerConfiguration

Описывает конфигурацию подсистемы балансировки нагрузки.

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

string

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

name

string

Имя подсистемы балансировки нагрузки

properties

LoadBalancerConfigurationProperties

Свойства конфигурации подсистемы балансировки нагрузки.

LoadBalancerConfigurationProperties

Описывает свойства конфигурации подсистемы балансировки нагрузки.

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

LoadBalancerFrontendIpConfiguration[]

Указывает интерфейсный IP-адрес, используемый для подсистемы балансировки нагрузки. Поддерживается только интерфейсный IP-адрес IPv4. Каждая конфигурация подсистемы балансировки нагрузки должна иметь ровно одну интерфейсную IP-конфигурацию.

LoadBalancerFrontendIpConfiguration

Указывает интерфейсный IP-адрес, используемый для подсистемы балансировки нагрузки. Поддерживается только интерфейсный IP-адрес IPv4. Каждая конфигурация подсистемы балансировки нагрузки должна иметь ровно одну интерфейсную IP-конфигурацию.

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

string

Имя ресурса, уникального в наборе интерфейсных IP-конфигураций, используемых подсистемой балансировки нагрузки. Это имя можно использовать для доступа к ресурсу.

properties

LoadBalancerFrontendIpConfigurationProperties

Свойства интерфейсной IP-конфигурации подсистемы балансировки нагрузки.

LoadBalancerFrontendIpConfigurationProperties

Описание IP-конфигурации облачной службы

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

string

Частный IP-адрес виртуальной сети IP-конфигурации.

publicIPAddress

SubResource

Ссылка на ресурс общедоступного IP-адреса.

subnet

SubResource

Ссылка на ресурс подсети виртуальной сети.

SubResource

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

string

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

SystemData

Системные метаданные, относящиеся к этому ресурсу.

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

string

Указывает время в формате UTC, когда был создан ресурс облачной службы (расширенная поддержка).
Минимальная версия API: 2022-04-04.

lastModifiedAt

string

Указывает время последнего изменения ресурса облачной службы (расширенной поддержки) в формате UTC.
Минимальная версия API: 2022-04-04.