Cloud Services - Get

Ссылка

Служба:: Compute

Версия API:: 2024-11-04

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
cloudServiceName	path	True	string	Имя облачной службы.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Ответы

Имя	Тип	Описание
200 OK	CloudService	ХОРОШО
Other Status Codes	CloudError	Ошибка

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Get Cloud Service with Multiple Roles and RDP Extension

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python cloud_service_get_with_multi_role_and_rdp.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.cloud_services.get(
        resource_group_name="ConstosoRG",
        cloud_service_name="{cs-name}",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2024-11-04/examples/CloudService_Get_WithMultiRoleAndRDP.json
if __name__ == "__main__":
    main()

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

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

Код состояния:: 200

{
  "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"
  },
  "systemData": {
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
  }
}

Определения

Имя	Описание
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
CloudError	Ответ на ошибку из службы вычислений.
CloudService	Описывает облачную службу.
CloudServiceExtensionProfile	Описывает профиль расширения облачной службы.
CloudServiceExtensionProperties	Свойства расширения.
CloudServiceNetworkProfile	Сетевой профиль облачной службы.
CloudServiceOsProfile	Описывает профиль ОС для облачной службы.
CloudServiceProperties	Свойства облачной службы
CloudServiceRoleProfile	Описывает профиль роли облачной службы.
CloudServiceRoleProfileProperties	Описывает свойства роли.
CloudServiceRoleSku	Описывает номер SKU роли облачной службы.
CloudServiceSlotType	Тип слота для облачной службы. Возможные значения: рабочей промежуточного Если значение не указано, значение по умолчанию — Production.
CloudServiceUpgradeMode	Режим обновления облачной службы. Экземпляры ролей выделяются для обновления доменов при развертывании службы. Обновления можно инициировать вручную в каждом домене обновления или автоматически инициировать во всех доменах обновления. Возможные значения автоза вручную одновременные Если значение по умолчанию не указано, значение по умолчанию — auto. Если задано значение "Вручную", для применения обновления необходимо вызвать PUT UpdateDomain. Если задано значение "Авто", обновление автоматически применяется к каждому домену обновления в последовательности.
CloudServiceVaultAndSecretReference	Защищенные параметры расширения, на которые ссылается keyVault, которые шифруются перед отправкой экземпляру роли.
CloudServiceVaultCertificate	Описывает одну ссылку на сертификат в Key Vault и место, где сертификат должен находиться в экземпляре роли.
CloudServiceVaultSecretGroup	Описывает набор сертификатов, которые находятся в одном хранилище ключей.
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), выбрана конкретная версия расширения. Если указана версия, автоматическое обновление выполняется в экземпляре роли.

CloudServiceNetworkProfile

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

Имя	Тип	Описание
loadBalancerConfigurations	LoadBalancerConfiguration[]	Список конфигураций подсистемы балансировки нагрузки. Облачная служба может иметь до двух конфигураций подсистемы балансировки нагрузки, соответствующих общедоступной подсистеме балансировки нагрузки и внутренней подсистеме балансировки нагрузки.
slotType	CloudServiceSlotType	Тип слота для облачной службы. Возможные значения: рабочей промежуточного Если значение не указано, значение по умолчанию — Production.
swappableCloudService	SubResource	Ссылка на идентификатор облачной службы, содержащей целевой IP-адрес, с помощью которого облачная служба субъекта может выполнить переключение. Это свойство невозможно обновить после установки. Переключаемая облачная служба, на которую ссылается этот идентификатор, должна присутствовать в противном случае будет вызвана ошибка.

CloudServiceOsProfile

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

Имя	Тип	Описание
secrets	CloudServiceVaultSecretGroup[]	Указывает набор сертификатов, которые должны быть установлены на экземпляры роли.

CloudServiceProperties

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

Имя	Тип	Описание
allowModelOverride	boolean	(Необязательно) Указывает, должны ли свойства sku роли (roleProfile.role.sku), указанные в модели или шаблоне, переопределить количество экземпляров ролей и размер виртуальной машины, указанные в CSCFG и CSDEF соответственно. Значение по умолчанию — `false`.
configuration	string	Указывает конфигурацию СЛУЖБЫ XML (CSCFG) для облачной службы.
configurationUrl	string	Указывает URL-адрес, ссылающийся на расположение конфигурации службы в службе BLOB-объектов. URL-адрес пакета службы может быть url-адресом URI подписанного URL-адреса (SAS) из любой учетной записи хранения. Это свойство только для записи и не возвращается в вызовах GET.
extensionProfile	CloudServiceExtensionProfile	Описывает профиль расширения облачной службы.
networkProfile	CloudServiceNetworkProfile	Сетевой профиль облачной службы.
osProfile	CloudServiceOsProfile	Описывает профиль ОС для облачной службы.
packageUrl	string	Указывает URL-адрес, ссылающийся на расположение пакета службы в службе BLOB-объектов. URL-адрес пакета службы может быть 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	Указывает уровень облачной службы. Возможные значения категории "Стандартный" базовый

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 в качестве секрета.
isBootstrapCertificate	boolean	Флаг, указывающий, указан ли сертификат начальной загрузки, используемый расширением Key Vault для получения оставшихся сертификатов.

CloudServiceVaultSecretGroup

Описывает набор сертификатов, которые находятся в одном хранилище ключей.

Имя	Тип	Описание
sourceVault	SubResource	Относительный URL-адрес Хранилища ключей, содержащий все сертификаты в 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.

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