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