Microsoft.Compute cloudServices 2022-04-04
Bicep リソース定義
cloudServices リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/cloudServices リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Compute/cloudServices@2022-04-04' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
allowModelOverride: bool
configuration: 'string'
configurationUrl: 'string'
extensionProfile: {
extensions: [
{
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
forceUpdateTag: 'string'
protectedSettings: any()
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
publisher: 'string'
rolesAppliedTo: [
'string'
]
settings: any()
type: 'string'
typeHandlerVersion: 'string'
}
}
]
}
networkProfile: {
loadBalancerConfigurations: [
{
id: 'string'
name: 'string'
properties: {
frontendIPConfigurations: [
{
name: 'string'
properties: {
privateIPAddress: 'string'
publicIPAddress: {
id: 'string'
}
subnet: {
id: 'string'
}
}
}
]
}
}
]
slotType: 'string'
swappableCloudService: {
id: 'string'
}
}
osProfile: {
secrets: [
{
sourceVault: {
id: 'string'
}
vaultCertificates: [
{
certificateUrl: 'string'
}
]
}
]
}
packageUrl: 'string'
roleProfile: {
roles: [
{
name: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
}
]
}
startCloudService: bool
upgradeMode: 'string'
}
systemData: {}
}
プロパティ値
cloudServices
名前 | 説明 | 値 |
---|---|---|
name | リソース名 | string (必須) 文字数制限: 1 から 15 有効な文字: スペース、制御文字、または次の文字は使用できません: ~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ? アンダースコアで開始することはできません。 末尾をピリオドまたはハイフンにすることはできません。 |
location | リソースの場所。 | string (必須) |
tags | リソース タグ。 | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
properties | クラウド サービスのプロパティ | CloudServiceProperties |
systemData | このリソースに関連するシステム メタデータ。 | SystemData |
CloudServiceProperties
名前 | 説明 | 値 |
---|---|---|
allowModelOverride | (省略可能)モデル/テンプレートで指定されたロール SKU プロパティ (roleProfile.roles.sku) が、.cscfg と .csdef で指定されたロール インスタンス数と vm サイズをそれぞれオーバーライドする必要があるかどうかを示します。 既定値は false です。 |
[bool] |
configuration | クラウド サービスの XML サービス構成 (.cscfg) を指定します。 | string |
configurationUrl | BLOB サービス内のサービス構成の場所を参照する URL を指定します。 サービス パッケージの URL は、任意のストレージ アカウントからの Shared Access Signature (SAS) URI にすることができます。 これは書き込み専用プロパティであり、GET 呼び出しでは返されません。 |
string |
extensionProfile | クラウド サービス拡張機能プロファイルについて説明します。 | CloudServiceExtensionProfile |
networkProfile | クラウド サービスのネットワーク プロファイル。 | CloudServiceNetworkProfile |
osProfile | クラウド サービスの OS プロファイルについて説明します。 | CloudServiceOsProfile |
packageUrl | BLOB Service 内のサービス パッケージの場所を表す URL を指定します。 サービス パッケージの URL は、任意のストレージ アカウントからの Shared Access Signature (SAS) URI にすることができます。 これは書き込み専用プロパティであり、GET 呼び出しでは返されません。 |
string |
roleProfile | クラウド サービスのロール プロファイルについて説明します。 | CloudServiceRoleProfile |
startCloudService | (省略可能)クラウド サービスが作成された直後に開始するかどうかを示します。 既定値は true です。false の場合、サービス モデルは引き続きデプロイされますが、コードはすぐには実行されません。 代わりに、サービスは Start を呼び出すまで PowerOff になり、その時点でサービスが開始されます。 デプロイされたサービスでは、電源がオフになっている場合でも料金が発生します。 |
[bool] |
upgradeMode | クラウド サービスの更新モード。 サービスがデプロイされると、ロール インスタンスは更新ドメインに割り当てられます。 更新は、各更新ドメインで手動で開始することも、すべての更新ドメインで自動的に開始することもできます。 使用できる値は次のとおりです。 Auto [手動] 同時 指定しない場合、既定値は Auto です。[手動] に設定されている場合は、更新プログラムを適用するために PUT UpdateDomain を呼び出す必要があります。 [自動] に設定すると、更新プログラムは各更新ドメインに順番に自動的に適用されます。 |
'Auto' 'Manual' '同時' |
CloudServiceExtensionProfile
名前 | 説明 | 値 |
---|---|---|
拡張機能 | クラウド サービスの拡張機能の一覧。 | Extension[] |
拡張子
名前 | 説明 | 値 |
---|---|---|
name | 拡張機能の名前です。 | string |
properties | 拡張機能のプロパティ。 | CloudServiceExtensionProperties |
CloudServiceExtensionProperties
名前 | 説明 | 値 |
---|---|---|
autoUpgradeMinorVersion | プラットフォームが使用可能になったときに typeHandlerVersion を上位のマイナー バージョンに自動的にアップグレードできるかどうかを明示的に指定します。 | [bool] |
forceUpdateTag | 指定されたパブリック設定と保護された設定を強制的に適用するタグ。 タグ値を変更すると、パブリックまたは保護された設定を変更せずに拡張機能を再実行できます。 forceUpdateTag が変更されていない場合でも、パブリック設定または保護された設定の更新はハンドラーによって適用されます。 forceUpdateTag もパブリックまたは保護された設定も変更されていない場合、拡張機能は同じシーケンス番号を持つロール インスタンスにフローされます。 再実行するかどうかは、ハンドラーの実装次第です |
string |
protectedSettings | ロール インスタンスに送信される前に暗号化される拡張機能の保護された設定。 | Bicep の場合は、 any() 関数を使用できます。 |
protectedSettingsFromKeyVault | 拡張機能の保護された設定。ロール インスタンスに送信される前に暗号化された KeyVault を使用して参照されます。 | CloudServiceVaultAndSecretReference |
publisher | 拡張ハンドラーの発行元の名前。 | string |
rolesAppliedTo | この拡張機能を適用するロールのオプションの一覧。 プロパティが指定されていない場合、または '*' が指定されている場合、拡張機能はクラウド サービス内のすべてのロールに適用されます。 | string[] |
settings | 拡張機能のパブリック設定。 JSON 拡張機能の場合、これは拡張機能の JSON 設定です。 XML 拡張機能 (RDP など) の場合、これは拡張機能の XML 設定です。 | Bicep の場合は、 any() 関数を使用できます。 |
type | 拡張機能の種類を指定します。 | string |
typeHandlerVersion | 拡張機能のバージョンを指定します。 拡張機能のバージョンを指定します。 この要素が指定されていない場合、またはアスタリスク (*) が値として使用されている場合は、最新バージョンの拡張機能が使用されます。 メジャー バージョン番号とアスタリスクをマイナー バージョン番号 (X.) として指定した場合は、指定したメジャー バージョンの最新マイナー バージョンが選択されます。 メジャー バージョン番号とマイナー バージョン番号が指定されている場合 (X.Y)、特定の拡張機能のバージョンが選択されます。 バージョンを指定した場合、ロール インスタンスで自動アップグレードが実行されます。 | string |
CloudServiceVaultAndSecretReference
名前 | 説明 | 値 |
---|---|---|
secretUrl | 拡張機能の保護された設定を含むシークレット URL | string |
sourceVault | Key Vaultの ARM リソース ID | サブリソース |
サブリソース
名前 | 説明 | 値 |
---|---|---|
id | リソース ID | string |
CloudServiceNetworkProfile
名前 | 説明 | 値 |
---|---|---|
loadBalancerConfigurations | ロード バランサー構成の一覧。 クラウド サービスには、パブリック Load Balancerと内部Load Balancerに対応する最大 2 つのロード バランサー構成を使用できます。 | LoadBalancerConfiguration[] |
slotType | クラウド サービスのスロットの種類。 設定可能な値は、次のとおりです。 運用 ステージング 指定しない場合、既定値は Production です。 |
'Production' 'Staging' |
swappableCloudService | サブジェクト クラウド サービスがスワップを実行できるターゲット IP を含むクラウド サービスの ID 参照。 このプロパティは、一度設定すると更新できません。 この ID で参照されるスワップ可能なクラウド サービスが存在する必要があります。そうしないと、エラーがスローされます。 | サブリソース |
LoadBalancerConfiguration
名前 | 説明 | 値 |
---|---|---|
id | リソース ID | string |
name | ロード バランサーの名前 | string (必須) |
properties | ロード バランサー構成のプロパティ。 | LoadBalancerConfigurationProperties (必須) |
LoadBalancerConfigurationProperties
名前 | 説明 | 値 |
---|---|---|
frontendIPConfigurations | ロード バランサーに使用するフロントエンド IP を指定します。 IPv4 フロントエンド IP アドレスのみがサポートされています。 各ロード バランサー構成には、フロントエンド IP 構成が 1 つだけ必要です。 | LoadBalancerFrontendIPConfiguration[] (必須) |
LoadBalancerFrontendIPConfiguration
名前 | 説明 | 値 |
---|---|---|
name | ロード バランサーによって使用されるフロントエンド IP 構成のセット内で一意であるリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string (必須) |
properties | ロード バランサーのフロントエンド IP 構成のプロパティ。 | LoadBalancerFrontendIPConfigurationProperties (必須) |
LoadBalancerFrontendIPConfigurationProperties
名前 | 説明 | 値 |
---|---|---|
privateIPAddress | IP 構成の仮想ネットワーク プライベート IP アドレス。 | string |
publicIPAddress | パブリック IP アドレス リソースへの参照。 | サブリソース |
サブネット | 仮想ネットワーク サブネット リソースへの参照。 | サブリソース |
CloudServiceOsProfile
名前 | 説明 | 値 |
---|---|---|
secrets | ロール インスタンスにインストールする必要がある証明書のセットを指定します。 | CloudServiceVaultSecretGroup[] |
CloudServiceVaultSecretGroup
名前 | 説明 | 値 |
---|---|---|
sourceVault | VaultCertificates 内のすべての証明書を含むKey Vaultの相対 URL。 | サブリソース |
vaultCertificates | 証明書を含む SourceVault のキー コンテナー参照の一覧。 | CloudServiceVaultCertificate[] |
CloudServiceVaultCertificate
名前 | 説明 | 値 |
---|---|---|
certificateUrl | これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 | string |
CloudServiceRoleProfile
名前 | 説明 | 値 |
---|---|---|
roles | クラウド サービスのロールの一覧。 | CloudServiceRoleProfileProperties[] |
CloudServiceRoleProfileProperties
名前 | 説明 | 値 |
---|---|---|
name | リソース名。 | string |
sku | クラウド サービス ロール SKU について説明します。 | CloudServiceRoleSku |
CloudServiceRoleSku
名前 | 説明 | 値 |
---|---|---|
capacity | クラウド サービス内のロール インスタンスの数を指定します。 | INT |
name | SKU 名。 注: クラウド サービスが現在オンになっているハードウェアで新しい SKU がサポートされていない場合は、クラウド サービスを削除して再作成するか、古い SKU に戻す必要があります。 | string |
レベル | クラウド サービスのレベルを指定します。 使用できる値は次のとおりです。 Standard Basic |
string |
SystemData
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ARM テンプレート リソース定義
cloudServices リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/cloudServices リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Compute/cloudServices",
"apiVersion": "2022-04-04",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"allowModelOverride": "bool",
"configuration": "string",
"configurationUrl": "string",
"extensionProfile": {
"extensions": [
{
"name": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"forceUpdateTag": "string",
"protectedSettings": {},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"publisher": "string",
"rolesAppliedTo": [ "string" ],
"settings": {},
"type": "string",
"typeHandlerVersion": "string"
}
}
]
},
"networkProfile": {
"loadBalancerConfigurations": [
{
"id": "string",
"name": "string",
"properties": {
"frontendIPConfigurations": [
{
"name": "string",
"properties": {
"privateIPAddress": "string",
"publicIPAddress": {
"id": "string"
},
"subnet": {
"id": "string"
}
}
}
]
}
}
],
"slotType": "string",
"swappableCloudService": {
"id": "string"
}
},
"osProfile": {
"secrets": [
{
"sourceVault": {
"id": "string"
},
"vaultCertificates": [
{
"certificateUrl": "string"
}
]
}
]
},
"packageUrl": "string",
"roleProfile": {
"roles": [
{
"name": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
}
}
]
},
"startCloudService": "bool",
"upgradeMode": "string"
},
"systemData": {}
}
プロパティ値
cloudServices
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.Compute/cloudServices' |
apiVersion | リソース API のバージョン | '2022-04-04' |
name | リソース名 | string (必須) 文字数制限: 1 から 15 有効な文字: スペース、制御文字、または次の文字は使用できません: ~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ? アンダースコアで開始することはできません。 末尾をピリオドまたはハイフンにすることはできません。 |
location | リソースの場所。 | string (必須) |
tags | リソース タグ。 | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
properties | クラウド サービスのプロパティ | CloudServiceProperties |
systemData | このリソースに関連するシステム メタデータ。 | SystemData |
CloudServiceProperties
名前 | 説明 | 値 |
---|---|---|
allowModelOverride | (省略可能)モデル/テンプレートで指定されたロール SKU プロパティ (roleProfile.roles.sku) が、.cscfg と .csdef で指定されたロール インスタンス数と vm サイズをそれぞれオーバーライドする必要があるかどうかを示します。 既定値は false です。 |
[bool] |
configuration | クラウド サービスの XML サービス構成 (.cscfg) を指定します。 | string |
configurationUrl | BLOB サービス内のサービス構成の場所を参照する URL を指定します。 サービス パッケージの URL は、任意のストレージ アカウントからの Shared Access Signature (SAS) URI にすることができます。 これは書き込み専用プロパティであり、GET 呼び出しでは返されません。 |
string |
extensionProfile | クラウド サービス拡張機能プロファイルについて説明します。 | CloudServiceExtensionProfile |
networkProfile | クラウド サービスのネットワーク プロファイル。 | CloudServiceNetworkProfile |
osProfile | クラウド サービスの OS プロファイルについて説明します。 | CloudServiceOsProfile |
packageUrl | BLOB Service 内のサービス パッケージの場所を表す URL を指定します。 サービス パッケージの URL は、任意のストレージ アカウントからの Shared Access Signature (SAS) URI にすることができます。 これは書き込み専用プロパティであり、GET 呼び出しでは返されません。 |
string |
roleProfile | クラウド サービスのロール プロファイルについて説明します。 | CloudServiceRoleProfile |
startCloudService | (省略可能)クラウド サービスが作成された直後に開始するかどうかを示します。 既定値は true です。false の場合、サービス モデルは引き続きデプロイされますが、コードはすぐには実行されません。 代わりに、サービスは Start を呼び出すまで PowerOff になり、その時点でサービスが開始されます。 デプロイされたサービスでは、電源がオフになっている場合でも料金が発生します。 |
[bool] |
upgradeMode | クラウド サービスの更新モード。 サービスがデプロイされると、ロール インスタンスは更新ドメインに割り当てられます。 更新は、各更新ドメインで手動で開始することも、すべての更新ドメインで自動的に開始することもできます。 使用できる値は次のとおりです。 Auto [手動] 同時 指定しない場合、既定値は Auto です。[手動] に設定されている場合は、更新プログラムを適用するために PUT UpdateDomain を呼び出す必要があります。 [自動] に設定すると、更新プログラムは各更新ドメインに順番に自動的に適用されます。 |
'Auto' 'Manual' '同時' |
CloudServiceExtensionProfile
名前 | 説明 | 値 |
---|---|---|
拡張機能 | クラウド サービスの拡張機能の一覧。 | Extension[] |
拡張子
名前 | 説明 | 値 |
---|---|---|
name | 拡張機能の名前です。 | string |
properties | 拡張機能のプロパティ。 | CloudServiceExtensionProperties |
CloudServiceExtensionProperties
名前 | 説明 | 値 |
---|---|---|
autoUpgradeMinorVersion | プラットフォームが使用可能になったときに typeHandlerVersion を上位のマイナー バージョンに自動的にアップグレードできるかどうかを明示的に指定します。 | [bool] |
forceUpdateTag | 指定されたパブリック設定と保護された設定を強制的に適用するタグ。 タグ値を変更すると、パブリックまたは保護された設定を変更せずに拡張機能を再実行できます。 forceUpdateTag が変更されていない場合でも、パブリック設定または保護された設定の更新はハンドラーによって適用されます。 forceUpdateTag もパブリックまたは保護された設定も変更されていない場合、拡張機能は同じシーケンス番号を持つロール インスタンスにフローされます。 再実行するかどうかは、ハンドラーの実装次第です |
string |
protectedSettings | ロール インスタンスに送信される前に暗号化される拡張機能の保護された設定。 | |
protectedSettingsFromKeyVault | 拡張機能の保護された設定。ロール インスタンスに送信される前に暗号化された KeyVault を使用して参照されます。 | CloudServiceVaultAndSecretReference |
publisher | 拡張ハンドラーの発行元の名前。 | string |
rolesAppliedTo | この拡張機能を適用するロールのオプションの一覧。 プロパティが指定されていない場合、または '*' が指定されている場合、拡張機能はクラウド サービス内のすべてのロールに適用されます。 | string[] |
settings | 拡張機能のパブリック設定。 JSON 拡張機能の場合、これは拡張機能の JSON 設定です。 XML 拡張機能 (RDP など) の場合、これは拡張機能の XML 設定です。 | |
type | 拡張機能の種類を指定します。 | string |
typeHandlerVersion | 拡張機能のバージョンを指定します。 拡張機能のバージョンを指定します。 この要素が指定されていない場合、またはアスタリスク (*) が値として使用されている場合は、最新バージョンの拡張機能が使用されます。 メジャー バージョン番号とアスタリスクをマイナー バージョン番号 (X.) として指定した場合は、指定したメジャー バージョンの最新マイナー バージョンが選択されます。 メジャー バージョン番号とマイナー バージョン番号が指定されている場合 (X.Y)、特定の拡張機能のバージョンが選択されます。 バージョンを指定した場合、ロール インスタンスで自動アップグレードが実行されます。 | string |
CloudServiceVaultAndSecretReference
名前 | 説明 | 値 |
---|---|---|
secretUrl | 拡張機能の保護された設定を含むシークレット URL | string |
sourceVault | Key Vaultの ARM リソース ID | サブリソース |
サブリソース
名前 | 説明 | 値 |
---|---|---|
id | リソース ID | string |
CloudServiceNetworkProfile
名前 | 説明 | 値 |
---|---|---|
loadBalancerConfigurations | ロード バランサー構成の一覧。 クラウド サービスには、パブリック Load Balancerと内部Load Balancerに対応する最大 2 つのロード バランサー構成を使用できます。 | LoadBalancerConfiguration[] |
slotType | クラウド サービスのスロットの種類。 設定可能な値は、次のとおりです。 運用 ステージング 指定しない場合、既定値は Production です。 |
'Production' 'Staging' |
swappableCloudService | サブジェクト クラウド サービスがスワップを実行できるターゲット IP を含むクラウド サービスの ID 参照。 このプロパティは、一度設定すると更新できません。 この ID で参照されるスワップ可能なクラウド サービスが存在する必要があります。そうしないと、エラーがスローされます。 | サブリソース |
LoadBalancerConfiguration
名前 | 説明 | 値 |
---|---|---|
id | リソース ID | string |
name | ロード バランサーの名前 | string (必須) |
properties | ロード バランサー構成のプロパティ。 | LoadBalancerConfigurationProperties (必須) |
LoadBalancerConfigurationProperties
名前 | 説明 | 値 |
---|---|---|
frontendIPConfigurations | ロード バランサーに使用するフロントエンド IP を指定します。 IPv4 フロントエンド IP アドレスのみがサポートされています。 各ロード バランサー構成には、フロントエンド IP 構成が 1 つだけ必要です。 | LoadBalancerFrontendIPConfiguration[] (必須) |
LoadBalancerFrontendIPConfiguration
名前 | 説明 | 値 |
---|---|---|
name | ロード バランサーによって使用されるフロントエンド IP 構成のセット内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string (必須) |
properties | ロード バランサーフロントエンド IP 構成のプロパティ。 | LoadBalancerFrontendIPConfigurationProperties (必須) |
LoadBalancerFrontendIPConfigurationProperties
名前 | 説明 | 値 |
---|---|---|
privateIPAddress | IP 構成の仮想ネットワーク プライベート IP アドレス。 | string |
publicIPAddress | パブリック IP アドレス リソースへの参照。 | サブリソース |
サブネット | 仮想ネットワーク サブネット リソースへの参照。 | サブリソース |
CloudServiceOsProfile
名前 | 説明 | 値 |
---|---|---|
secrets | ロール インスタンスにインストールする必要がある証明書のセットを指定します。 | CloudServiceVaultSecretGroup[] |
CloudServiceVaultSecretGroup
名前 | 説明 | 値 |
---|---|---|
sourceVault | VaultCertificates のすべての証明書を含むKey Vaultの相対 URL。 | サブリソース |
vaultCertificates | 証明書を含む SourceVault 内のキー コンテナー参照の一覧。 | CloudServiceVaultCertificate[] |
CloudServiceVaultCertificate
名前 | 説明 | 値 |
---|---|---|
certificateUrl | これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 | string |
CloudServiceRoleProfile
名前 | 説明 | 値 |
---|---|---|
roles | クラウド サービスのロールの一覧。 | CloudServiceRoleProfileProperties[] |
CloudServiceRoleProfileProperties
名前 | 説明 | 値 |
---|---|---|
name | リソース名。 | string |
sku | クラウド サービス ロール SKU について説明します。 | CloudServiceRoleSku |
CloudServiceRoleSku
名前 | 説明 | 値 |
---|---|---|
capacity | クラウド サービス内のロール インスタンスの数を指定します。 | INT |
name | SKU 名。 注: クラウド サービスが現在有効になっているハードウェアで新しい SKU がサポートされていない場合は、クラウド サービスを削除して再作成するか、古い SKU に戻す必要があります。 | string |
レベル | クラウド サービスの層を指定します。 使用できる値は次のとおりです。 Standard Basic |
string |
SystemData
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
Terraform (AzAPI プロバイダー) リソース定義
cloudServices リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Compute/cloudServices リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/cloudServices@2022-04-04"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
allowModelOverride = bool
configuration = "string"
configurationUrl = "string"
extensionProfile = {
extensions = [
{
name = "string"
properties = {
autoUpgradeMinorVersion = bool
forceUpdateTag = "string"
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
publisher = "string"
rolesAppliedTo = [
"string"
]
type = "string"
typeHandlerVersion = "string"
}
}
]
}
networkProfile = {
loadBalancerConfigurations = [
{
id = "string"
name = "string"
properties = {
frontendIPConfigurations = [
{
name = "string"
properties = {
privateIPAddress = "string"
publicIPAddress = {
id = "string"
}
subnet = {
id = "string"
}
}
}
]
}
}
]
slotType = "string"
swappableCloudService = {
id = "string"
}
}
osProfile = {
secrets = [
{
sourceVault = {
id = "string"
}
vaultCertificates = [
{
certificateUrl = "string"
}
]
}
]
}
packageUrl = "string"
roleProfile = {
roles = [
{
name = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
}
]
}
startCloudService = bool
upgradeMode = "string"
}
systemData = {}
})
}
プロパティ値
cloudServices
Name | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.Compute/cloudServices@2022-04-04" |
name | リソース名 | string (必須) 文字数制限: 1 から 15 有効な文字: スペース、制御文字、または次の文字は使用できません: ~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ? アンダースコアで開始することはできません。 末尾をピリオドまたはハイフンにすることはできません。 |
location | リソースの場所。 | string (必須) |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
tags | リソース タグ。 | タグ名と値のディクショナリ。 |
properties | クラウド サービスのプロパティ | CloudServiceProperties |
systemData | このリソースに関連するシステム メタデータ。 | SystemData |
CloudServiceProperties
Name | 説明 | 値 |
---|---|---|
allowModelOverride | (省略可能)モデル/テンプレートで指定されたロール SKU プロパティ (roleProfile.roles.sku) が、.cscfg と .csdef で指定されたロール インスタンス数と vm サイズをそれぞれオーバーライドする必要があるかどうかを示します。 既定値は false です。 |
[bool] |
configuration | クラウド サービスの XML サービス構成 (.cscfg) を指定します。 | string |
configurationUrl | BLOB サービス内のサービス構成の場所を参照する URL を指定します。 サービス パッケージの URL は、任意のストレージ アカウントからの Shared Access Signature (SAS) URI にすることができます。 これは書き込み専用プロパティであり、GET 呼び出しでは返されません。 |
string |
extensionProfile | クラウド サービス拡張機能プロファイルについて説明します。 | CloudServiceExtensionProfile |
networkProfile | クラウド サービスのネットワーク プロファイル。 | CloudServiceNetworkProfile |
osProfile | クラウド サービスの OS プロファイルについて説明します。 | CloudServiceOsProfile |
packageUrl | BLOB Service 内のサービス パッケージの場所を表す URL を指定します。 サービス パッケージの URL は、任意のストレージ アカウントからの Shared Access Signature (SAS) URI にすることができます。 これは書き込み専用プロパティであり、GET 呼び出しでは返されません。 |
string |
roleProfile | クラウド サービスのロール プロファイルについて説明します。 | CloudServiceRoleProfile |
startCloudService | (省略可能)クラウド サービスが作成された直後に開始するかどうかを示します。 既定値は true です。false の場合、サービス モデルは引き続きデプロイされますが、コードはすぐには実行されません。 代わりに、サービスは Start を呼び出すまで PowerOff になり、その時点でサービスが開始されます。 デプロイされたサービスでは、電源がオフになっている場合でも料金が発生します。 |
[bool] |
upgradeMode | クラウド サービスの更新モード。 サービスがデプロイされると、ロール インスタンスは更新ドメインに割り当てられます。 更新は、各更新ドメインで手動で開始することも、すべての更新ドメインで自動的に開始することもできます。 使用できる値は次のとおりです。 Auto [手動] 同時 指定しない場合、既定値は Auto です。[手動] に設定されている場合は、更新プログラムを適用するために PUT UpdateDomain を呼び出す必要があります。 [自動] に設定すると、更新プログラムは各更新ドメインに順番に自動的に適用されます。 |
"Auto" "Manual" "同時" |
CloudServiceExtensionProfile
Name | 説明 | 値 |
---|---|---|
拡張機能 | クラウド サービスの拡張機能の一覧。 | Extension[] |
拡張子
名前 | 説明 | 値 |
---|---|---|
name | 拡張機能の名前です。 | string |
properties | 拡張機能のプロパティ。 | CloudServiceExtensionProperties |
CloudServiceExtensionProperties
Name | 説明 | 値 |
---|---|---|
autoUpgradeMinorVersion | プラットフォームが使用可能になったときに typeHandlerVersion を上位のマイナー バージョンに自動的にアップグレードできるかどうかを明示的に指定します。 | [bool] |
forceUpdateTag | 指定されたパブリック設定と保護された設定を強制的に適用するタグ。 タグ値を変更すると、パブリックまたは保護された設定を変更せずに拡張機能を再実行できます。 forceUpdateTag が変更されていない場合でも、パブリック設定または保護された設定の更新はハンドラーによって適用されます。 forceUpdateTag もパブリックまたは保護された設定も変更されていない場合、拡張機能は同じシーケンス番号を持つロール インスタンスにフローされます。 再実行するかどうかは、ハンドラーの実装次第です |
string |
protectedSettings | ロール インスタンスに送信される前に暗号化される拡張機能の保護された設定。 | |
protectedSettingsFromKeyVault | 拡張機能の保護された設定。ロール インスタンスに送信される前に暗号化された KeyVault を使用して参照されます。 | CloudServiceVaultAndSecretReference |
publisher | 拡張ハンドラーの発行元の名前。 | string |
rolesAppliedTo | この拡張機能を適用するロールのオプションの一覧。 プロパティが指定されていない場合、または '*' が指定されている場合、拡張機能はクラウド サービス内のすべてのロールに適用されます。 | string[] |
settings | 拡張機能のパブリック設定。 JSON 拡張機能の場合、これは拡張機能の JSON 設定です。 XML 拡張機能 (RDP など) の場合、これは拡張機能の XML 設定です。 | |
type | 拡張機能の種類を指定します。 | string |
typeHandlerVersion | 拡張機能のバージョンを指定します。 拡張機能のバージョンを指定します。 この要素が指定されていない場合、またはアスタリスク (*) が値として使用されている場合は、最新バージョンの拡張機能が使用されます。 メジャー バージョン番号とアスタリスクをマイナー バージョン番号 (X.) として指定した場合は、指定したメジャー バージョンの最新マイナー バージョンが選択されます。 メジャー バージョン番号とマイナー バージョン番号が指定されている場合 (X.Y)、特定の拡張機能のバージョンが選択されます。 バージョンを指定した場合、ロール インスタンスで自動アップグレードが実行されます。 | string |
CloudServiceVaultAndSecretReference
Name | 説明 | 値 |
---|---|---|
secretUrl | 拡張機能の保護された設定を含むシークレット URL | string |
sourceVault | Key Vaultの ARM リソース ID | サブリソース |
サブリソース
Name | 説明 | 値 |
---|---|---|
id | リソース ID | string |
CloudServiceNetworkProfile
Name | 説明 | 値 |
---|---|---|
loadBalancerConfigurations | ロード バランサー構成の一覧。 クラウド サービスには、パブリック Load Balancerと内部Load Balancerに対応する最大 2 つのロード バランサー構成を使用できます。 | LoadBalancerConfiguration[] |
slotType | クラウド サービスのスロットの種類。 設定可能な値は、次のとおりです。 運用 ステージング 指定しない場合、既定値は Production です。 |
"Production" "ステージング" |
swappableCloudService | サブジェクト クラウド サービスがスワップを実行できるターゲット IP を含むクラウド サービスの ID 参照。 このプロパティは、一度設定すると更新できません。 この ID で参照されるスワップ可能なクラウド サービスが存在する必要があります。そうしないと、エラーがスローされます。 | サブリソース |
LoadBalancerConfiguration
Name | 説明 | 値 |
---|---|---|
id | リソース ID | string |
name | ロード バランサーの名前 | string (必須) |
properties | ロード バランサー構成のプロパティ。 | LoadBalancerConfigurationProperties (必須) |
LoadBalancerConfigurationProperties
Name | 説明 | 値 |
---|---|---|
frontendIPConfigurations | ロード バランサーに使用するフロントエンド IP を指定します。 IPv4 フロントエンド IP アドレスのみがサポートされています。 各ロード バランサー構成には、フロントエンド IP 構成が 1 つだけ必要です。 | LoadBalancerFrontendIPConfiguration[] (必須) |
LoadBalancerFrontendIPConfiguration
名前 | 説明 | 値 |
---|---|---|
name | ロード バランサーによって使用されるフロントエンド IP 構成のセット内で一意のリソースの名前。 この名前は、リソースへのアクセスに使用できます。 | string (必須) |
properties | ロード バランサーフロントエンド IP 構成のプロパティ。 | LoadBalancerFrontendIPConfigurationProperties (必須) |
LoadBalancerFrontendIPConfigurationProperties
名前 | 説明 | 値 |
---|---|---|
privateIPAddress | IP 構成の仮想ネットワーク プライベート IP アドレス。 | string |
publicIPAddress | パブリック IP アドレス リソースへの参照。 | サブリソース |
サブネット | 仮想ネットワーク サブネット リソースへの参照。 | サブリソース |
CloudServiceOsProfile
名前 | 説明 | 値 |
---|---|---|
secrets | ロール インスタンスにインストールする必要がある証明書のセットを指定します。 | CloudServiceVaultSecretGroup[] |
CloudServiceVaultSecretGroup
名前 | 説明 | 値 |
---|---|---|
sourceVault | VaultCertificates のすべての証明書を含むKey Vaultの相対 URL。 | サブリソース |
vaultCertificates | 証明書を含む SourceVault 内のキー コンテナー参照の一覧。 | CloudServiceVaultCertificate[] |
CloudServiceVaultCertificate
名前 | 説明 | 値 |
---|---|---|
certificateUrl | これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 | string |
CloudServiceRoleProfile
名前 | 説明 | 値 |
---|---|---|
roles | クラウド サービスのロールの一覧。 | CloudServiceRoleProfileProperties[] |
CloudServiceRoleProfileProperties
名前 | 説明 | 値 |
---|---|---|
name | リソース名。 | string |
sku | クラウド サービス ロール SKU について説明します。 | CloudServiceRoleSku |
CloudServiceRoleSku
名前 | 説明 | 値 |
---|---|---|
capacity | クラウド サービス内のロール インスタンスの数を指定します。 | INT |
name | SKU 名。 注: クラウド サービスが現在有効になっているハードウェアで新しい SKU がサポートされていない場合は、クラウド サービスを削除して再作成するか、古い SKU に戻す必要があります。 | string |
レベル | クラウド サービスの層を指定します。 使用できる値は次のとおりです。 Standard Basic |
string |
SystemData
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。