次の方法で共有


Cloud Services - List

リソース グループのすべてのクラウド サービスの一覧を取得します。 応答で nextLink プロパティを使用して、Cloud Servicesの次のページを取得します。 nextLink が null になるまでこれを行って、すべてのCloud Servicesをフェッチします。

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 サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True

string

クライアント API のバージョン。

応答

名前 説明
200 OK

CloudServiceListResult

OK

Other Status Codes

CloudError

エラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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

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

CloudServiceProperties

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

CloudServiceRoleProfile

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

CloudServiceRoleProfileProperties

ロールのプロパティについて説明します。

CloudServiceRoleSku

クラウド サービス ロール SKU について説明します。

CloudServiceSlotType

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

運用

ステージング

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

CloudServiceUpgradeMode

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

Auto

手動

同時

指定しない場合、既定値は 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)、特定の拡張機能のバージョンが選択されます。 バージョンを指定した場合、ロール インスタンスで自動アップグレードが実行されます。

CloudServiceListResult

リスト操作の結果。

名前 説明
nextLink

string

リソースの次のページをフェッチする URI。 これを使用して、リソースの次のページを取得します。 nextLink が null になるまでこれを行って、すべてのリソースをフェッチします。

value

CloudService[]

リソースの一覧。

CloudServiceNetworkProfile

クラウド サービスのネットワーク プロファイル。

名前 説明
loadBalancerConfigurations

LoadBalancerConfiguration[]

ロード バランサー構成の一覧。 クラウド サービスには、パブリック Load Balancerと内部Load Balancerに対応する最大 2 つのロード バランサー構成を使用できます。

slotType

CloudServiceSlotType

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

運用

ステージング

指定しない場合、既定値は 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 Service 内のサービス パッケージの場所を表す URL を指定します。 サービス パッケージの URL は、任意のストレージ アカウントからの Shared Access Signature (SAS) URI にすることができます。 これは書き込み専用プロパティであり、GET 呼び出しでは返されません。

provisioningState

string

プロビジョニング状態。これは応答にのみ表示されます。

roleProfile

CloudServiceRoleProfile

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

startCloudService

boolean

(省略可能)クラウド サービスが作成された直後に開始するかどうかを示します。 既定値は true です。 false の場合、サービス モデルは引き続きデプロイされますが、コードはすぐには実行されません。 代わりに、サービスは Start を呼び出すまで PowerOff になり、その時点でサービスが開始されます。 デプロイされたサービスでは、電源がオフになっている場合でも料金が発生します。

uniqueId

string

クラウド サービスの一意識別子。

upgradeMode

CloudServiceUpgradeMode

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

Auto

手動

同時

指定しない場合、既定値は 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

string

Staging

string

CloudServiceUpgradeMode

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

Auto

手動

同時

指定しない場合、既定値は 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 です。

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-version: 2022-04-04。

lastModifiedAt

string

クラウド サービス (延長サポート) リソースが最後に変更された時刻を UTC で指定します。
最小 api-version: 2022-04-04。