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 サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	CloudService	わかりました
Other Status Codes	CloudError	エラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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	クラウドサービスの OS プロファイルについて説明します。
CloudServiceProperties	クラウドサービスのプロパティ
CloudServiceRoleProfile	クラウドサービスのロールプロファイルについて説明します。
CloudServiceRoleProfileProperties	ロールのプロパティについて説明します。
CloudServiceRoleSku	クラウドサービスロール SKU について説明します。
CloudServiceSlotType	クラウドサービスのスロットの種類。使用可能な値は次のとおりです。 Production ステージングの指定しない場合、既定値は Production です。
CloudServiceUpgradeMode	クラウドサービスの更新モード。ロールインスタンスは、サービスのデプロイ時に更新ドメインに割り当てられます。更新プログラムは、各更新ドメインで手動で開始することも、すべての更新ドメインで自動的に開始することもできます。使用可能な値は次のとおりです。自動の手動の同時指定しない場合、既定値は Auto です。[手動] に設定されている場合は、更新プログラムを適用するために PUT UpdateDomain を呼び出す必要があります。 [自動] に設定すると、更新プログラムは各更新ドメインに順番に自動的に適用されます。
CloudServiceVaultAndSecretReference	拡張機能の保護された設定。ロールインスタンスに送信される前に暗号化された KeyVault を使用して参照されます。
CloudServiceVaultCertificate	Key Vault 内の 1 つの証明書参照と、ロールインスタンス上の証明書の場所について説明します。
CloudServiceVaultSecretGroup	すべて同じ Key Vault 内にある証明書のセットについて説明します。
Extension	クラウドサービス拡張機能について説明します。
InnerError	内部エラーの詳細。
LoadBalancerConfiguration	ロードバランサーの構成について説明します。
LoadBalancerConfigurationProperties	ロードバランサー構成のプロパティについて説明します。
LoadBalancerFrontendIpConfiguration	ロードバランサーに使用するフロントエンド IP を指定します。 IPv4 フロントエンド IP アドレスのみがサポートされています。各ロードバランサー構成には、フロントエンド IP 構成が 1 つだけ必要です。
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	リソース ID。
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[]	ロードバランサーの構成の一覧。クラウドサービスは、パブリックロードバランサーと内部ロードバランサーに対応する最大 2 つのロードバランサー構成を持つことができます。
slotType	CloudServiceSlotType	クラウドサービスのスロットの種類。使用可能な値は次のとおりです。 Production ステージングの指定しない場合、既定値は Production です。
swappableCloudService	SubResource	サブジェクトクラウドサービスがスワップを実行できるターゲット IP を含むクラウドサービスの ID 参照。このプロパティは、一度設定すると更新できません。この ID によって参照されるスワップ可能なクラウドサービスが存在する必要があります。そうしないと、エラーがスローされます。

CloudServiceOsProfile

クラウドサービスの OS プロファイルについて説明します。

名前	型	説明
secrets	CloudServiceVaultSecretGroup[]	ロールインスタンスにインストールする必要がある証明書のセットを指定します。

CloudServiceProperties

クラウドサービスのプロパティ

名前	型	説明
allowModelOverride	boolean	(省略可能)モデル/テンプレートで指定されたロール SKU プロパティ (roleProfile.roles.sku) が、.cscfg と .csdef で指定されたロールインスタンス数と VM サイズをそれぞれオーバーライドする必要があるかどうかを示します。既定値は `false`です。
configuration	string	クラウドサービスの XML サービス構成 (.cscfg) を指定します。
configurationUrl	string	BLOB サービス内のサービス構成の場所を参照する URL を指定します。サービスパッケージの URL には、任意のストレージアカウントからの Shared Access Signature (SAS) URI を指定できます。これは書き込み専用プロパティであり、GET 呼び出しでは返されません。
extensionProfile	CloudServiceExtensionProfile	クラウドサービス拡張機能プロファイルについて説明します。
networkProfile	CloudServiceNetworkProfile	クラウドサービスのネットワークプロファイル。
osProfile	CloudServiceOsProfile	クラウドサービスの OS プロファイルについて説明します。
packageUrl	string	BLOB サービス内のサービスパッケージの場所を参照する URL を指定します。サービスパッケージの URL には、任意のストレージアカウントからの Shared Access Signature (SAS) URI を指定できます。これは書き込み専用プロパティであり、GET 呼び出しでは返されません。
provisioningState	string	プロビジョニング状態。応答にのみ表示されます。
roleProfile	CloudServiceRoleProfile	クラウドサービスのロールプロファイルについて説明します。
startCloudService	boolean	(省略可能)作成された直後にクラウドサービスを開始するかどうかを示します。既定値は `true`です。 false の場合、サービスモデルはまだデプロイされますが、コードはすぐには実行されません。代わりに、サービスは Start を呼び出すまで PoweredOff になり、その時点でサービスが開始されます。デプロイされたサービスでは、電源がオフになっている場合でも料金が発生します。
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 Basic

CloudServiceSlotType

クラウドサービスのスロットの種類。使用可能な値は次のとおりです。

Production

ステージングの

指定しない場合、既定値は Production です。

名前	型	説明
Production	string
Staging	string

CloudServiceUpgradeMode

クラウドサービスの更新モード。ロールインスタンスは、サービスのデプロイ時に更新ドメインに割り当てられます。更新プログラムは、各更新ドメインで手動で開始することも、すべての更新ドメインで自動的に開始することもできます。使用可能な値は次のとおりです。

自動の

手動の

同時

指定しない場合、既定値は Auto です。[手動] に設定されている場合は、更新プログラムを適用するために PUT UpdateDomain を呼び出す必要があります。 [自動] に設定すると、更新プログラムは各更新ドメインに順番に自動的に適用されます。

名前	型	説明
Auto	string
Manual	string
Simultaneous	string

CloudServiceVaultAndSecretReference

拡張機能の保護された設定。ロールインスタンスに送信される前に暗号化された KeyVault を使用して参照されます。

名前	型	説明
secretUrl	string	拡張機能の保護された設定を含むシークレット URL
sourceVault	SubResource	Key Vault の ARM リソース ID

CloudServiceVaultCertificate

Key Vault 内の 1 つの証明書参照と、ロールインスタンス上の証明書の場所について説明します。

名前	型	説明
certificateUrl	string	これは、シークレットとして Key Vault にアップロードされた証明書の URL です。
isBootstrapCertificate	boolean	指定された証明書が、残りの証明書をフェッチするために Key Vault 拡張機能によって使用されるブートストラップ証明書であるかどうかを示すフラグ。

CloudServiceVaultSecretGroup

すべて同じ Key Vault 内にある証明書のセットについて説明します。

名前	型	説明
sourceVault	SubResource	VaultCertificates 内のすべての証明書を含む Key Vault の相対 URL。
vaultCertificates	CloudServiceVaultCertificate[]	証明書を含む SourceVault 内のキーコンテナー参照の一覧。

Extension

クラウドサービス拡張機能について説明します。

名前	型	説明
name	string	拡張機能の名前。
properties	CloudServiceExtensionProperties	拡張機能のプロパティ。

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

LoadBalancerConfiguration

ロードバランサーの構成について説明します。

名前	型	説明
id	string	リソース ID
name	string	ロードバランサーの名前
properties	LoadBalancerConfigurationProperties	ロードバランサー構成のプロパティ。

LoadBalancerConfigurationProperties

ロードバランサー構成のプロパティについて説明します。

名前	型	説明
frontendIpConfigurations	LoadBalancerFrontendIpConfiguration[]	ロードバランサーに使用するフロントエンド IP を指定します。 IPv4 フロントエンド IP アドレスのみがサポートされています。各ロードバランサー構成には、フロントエンド IP 構成が 1 つだけ必要です。

LoadBalancerFrontendIpConfiguration

ロードバランサーに使用するフロントエンド IP を指定します。 IPv4 フロントエンド IP アドレスのみがサポートされています。各ロードバランサー構成には、フロントエンド IP 構成が 1 つだけ必要です。

名前	型	説明
name	string	ロードバランサーによって使用されるフロントエンド IP 構成のセット内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties	LoadBalancerFrontendIpConfigurationProperties	ロードバランサーのフロントエンド IP 構成のプロパティ。

LoadBalancerFrontendIpConfigurationProperties

クラウドサービスの IP 構成について説明します

名前	型	説明
privateIPAddress	string	IP 構成の仮想ネットワークプライベート IP アドレス。
publicIPAddress	SubResource	パブリック IP アドレスリソースへの参照。
subnet	SubResource	仮想ネットワークサブネットリソースへの参照。

SubResource

名前	型	説明
id	string	リソース ID

SystemData

このリソースに関連するシステムメタデータ。

名前	型	説明
createdAt	string	クラウドサービス (延長サポート) リソースが作成された時刻を UTC で指定します。最小 API バージョン: 2022-04-04。
lastModifiedAt	string	クラウドサービス (延長サポート) リソースが最後に変更された時刻を UTC で指定します。最小 API バージョン: 2022-04-04。

次の方法で共有