Microsoft.ContainerInstance containerGroups 2018-02-01-preview
- [アーティクル]
-
-
Bicep リソース定義
containerGroups リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.ContainerInstance/containerGroups リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2018-02-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
containers: [
{
name: 'string'
properties: {
command: [
'string'
]
environmentVariables: [
{
name: 'string'
value: 'string'
}
]
image: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
resources: {
limits: {
cpu: int
memoryInGB: json('decimal-as-string')
}
requests: {
cpu: int
memoryInGB: json('decimal-as-string')
}
}
volumeMounts: [
{
mountPath: 'string'
name: 'string'
readOnly: bool
}
]
}
}
]
imageRegistryCredentials: [
{
password: 'string'
server: 'string'
username: 'string'
}
]
ipAddress: {
dnsNameLabel: 'string'
ip: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
type: 'Public'
}
osType: 'string'
restartPolicy: 'string'
volumes: [
{
azureFile: {
readOnly: bool
shareName: 'string'
storageAccountKey: 'string'
storageAccountName: 'string'
}
emptyDir: any()
gitRepo: {
directory: 'string'
repository: 'string'
revision: 'string'
}
name: 'string'
secret: {}
}
]
}
}
プロパティ値
containerGroups
| 名前 |
説明 |
値 |
| name |
リソース名 |
string (必須)
文字制限: 1 から 63
有効な文字:
小文字、数字、およびハイフン。
先頭または末尾をハイフンにすることはできません。 連続するハイフンは使用できません。 |
| location |
リソースの場所。 |
string |
| tags |
リソース タグ。 |
タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| properties |
|
ContainerGroupProperties (必須) |
ContainerGroupProperties
| 名前 |
説明 |
値 |
| containers |
コンテナー グループ内のコンテナー。 |
Container[] (必須) |
| imageRegistryCredentials |
コンテナー グループの作成に使用されたイメージ レジストリの資格情報。 |
ImageRegistryCredential[] |
| ipAddress |
コンテナー グループの IP アドレスの種類。 |
IpAddress |
| osType |
コンテナー グループ内のコンテナーで必要なオペレーティング システムの種類。 |
'Linux'
'Windows' (必須) |
| restartPolicy |
コンテナー グループ内のすべてのコンテナーの再起動ポリシー。
- Always 常に再起動する
- OnFailure 障害発生時に再起動する
- Never 再起動しない |
'Always'
'Never'
'OnFailure' |
| volumes |
このコンテナー グループのコンテナーによってマウントできるボリュームのリスト。 |
Volume[] |
コンテナー
| 名前 |
説明 |
値 |
| name |
ユーザーが指定したコンテナー インスタンスの名前。 |
string (必須) |
| properties |
コンテナー インスタンスのプロパティ。 |
ContainerProperties (必須) |
ContainerProperties
| 名前 |
説明 |
値 |
| command |
コンテナー インスタンス内で実行する exec 形式のコマンド。 |
string[] |
| environmentVariables |
コンテナー インスタンス内で設定する環境変数。 |
EnvironmentVariable[] |
| image |
コンテナー インスタンスの作成に使用されるイメージの名前。 |
string (必須) |
| ports |
コンテナー インスタンスで公開されているポート。 |
ContainerPort[] |
| resources |
コンテナー インスタンスのリソース要件。 |
ResourceRequirements (必須) |
| volumeMounts |
コンテナー インスタンスで使用可能なボリューム マウント。 |
VolumeMount[] |
EnvironmentVariable
| 名前 |
説明 |
値 |
| name |
環境変数の名前。 |
string (必須) |
| value |
環境変数の値。 |
string (必須) |
ContainerPort
| 名前 |
説明 |
値 |
| port |
コンテナー グループ内で公開されているポート番号。 |
int (必須) |
| protocol |
ポートに関連付けられているプロトコル。 |
'TCP'
'UDP' |
ResourceRequirements
ResourceLimits
| 名前 |
説明 |
値 |
| cpu |
このコンテナー インスタンスの CPU 制限。 |
INT |
| memoryInGB |
このコンテナー インスタンスのメモリ制限 (GB 単位)。 10 進値を指定するには、 json() 関数を使用します。 |
int または json decimal |
ResourceRequests
| 名前 |
説明 |
値 |
| cpu |
このコンテナー インスタンスの CPU 要求。 |
int (必須) |
| memoryInGB |
このコンテナー インスタンスのメモリ要求 (GB 単位)。 10 進値を指定するには、 json() 関数を使用します。 |
int または json decimal (必須) |
VolumeMount
| 名前 |
説明 |
値 |
| mountPath |
ボリュームをマウントする必要があるコンテナー内のパス。 コロン (:) を含めることはできません。 |
string (必須) |
| name |
ボリューム マウントの名前。 |
string (必須) |
| readOnly |
ボリューム マウントが読み取り専用かどうかを示すフラグ。 |
[bool] |
ImageRegistryCredential
| 名前 |
説明 |
値 |
| password |
プライベート レジストリのパスワード。 |
string |
| server |
"http" や "https" などのプロトコルを除いた Docker イメージ レジストリ サーバー。 |
string (必須) |
| username |
プライベート レジストリのユーザー名。 |
string (必須) |
IpAddress
| 名前 |
説明 |
値 |
| dnsNameLabel |
IP の DNS 名ラベル。 |
string |
| ip |
パブリック インターネットに公開されている IP。 |
string |
| ports |
コンテナー グループで公開されているポートのリスト。 |
Port[] (必須) |
| 型 |
IP がパブリック インターネットに公開されるかどうかを指定します。 |
'Public' (必須) |
Port
| 名前 |
説明 |
値 |
| port |
ポート番号。 |
int (必須) |
| protocol |
ポートに関連付けられているプロトコル。 |
'TCP'
'UDP' |
ボリューム
| 名前 |
説明 |
値 |
| azureFile |
Azure File ボリューム。 |
AzureFileVolume |
| emptyDir |
空のディレクトリ ボリューム。 |
Bicep の場合は、 any() 関数を使用できます。 |
| gitRepo |
Git リポジトリ ボリューム。 |
GitRepoVolume |
| name |
ボリュームの名前。 |
string (必須) |
| secret |
シークレット ボリューム。 |
object |
AzureFileVolume
| 名前 |
説明 |
値 |
| readOnly |
ボリュームとしてマウントされている Azure ファイル共有が読み取り専用かどうかを示すフラグ。 |
[bool] |
| shareName |
ボリュームとしてマウントされる Azure ファイル共有の名前。 |
string (必須) |
| storageAccountKey |
Azure ファイル共有にアクセスするために使用されるストレージ アカウント アクセス キー。 |
string |
| storageAccountName |
Azure ファイル共有が含まれているストレージ アカウントの名前。 |
string (必須) |
GitRepoVolume
| 名前 |
説明 |
値 |
| directory |
ターゲット ディレクトリの名前。 ".." が含まれていたり、".." で始まっていたりすることはできません。 "." を指定した場合、ボリューム ディレクトリは Git リポジトリになります。 それ以外の場合、指定すると、ボリュームの指定された名前のサブディレクトリに Git リポジトリが含まれます。 |
string |
| repository |
リポジトリの URL |
string (必須) |
| revision |
指定されたリビジョンのコミット ハッシュ。 |
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
ARM テンプレート リソース定義
containerGroups リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.ContainerInstance/containerGroups リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2018-02-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"containers": [
{
"name": "string",
"properties": {
"command": [ "string" ],
"environmentVariables": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"resources": {
"limits": {
"cpu": "int",
"memoryInGB": "[json('decimal-as-string')]"
},
"requests": {
"cpu": "int",
"memoryInGB": "[json('decimal-as-string')]"
}
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": "bool"
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": "string",
"server": "string",
"username": "string"
}
],
"ipAddress": {
"dnsNameLabel": "string",
"ip": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"type": "Public"
},
"osType": "string",
"restartPolicy": "string",
"volumes": [
{
"azureFile": {
"readOnly": "bool",
"shareName": "string",
"storageAccountKey": "string",
"storageAccountName": "string"
},
"emptyDir": {},
"gitRepo": {
"directory": "string",
"repository": "string",
"revision": "string"
},
"name": "string",
"secret": {}
}
]
}
}
プロパティ値
containerGroups
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
'Microsoft.ContainerInstance/containerGroups' |
| apiVersion |
リソース API のバージョン |
'2018-02-01-preview' |
| name |
リソース名 |
string (必須)
文字数制限: 1 から 63
有効な文字:
小文字、数字、およびハイフン。
先頭または末尾をハイフンにすることはできません。 連続するハイフンは使用できません。 |
| location |
リソースの場所。 |
string |
| tags |
リソース タグ。 |
タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| properties |
|
ContainerGroupProperties (必須) |
ContainerGroupProperties
| 名前 |
説明 |
値 |
| containers |
コンテナー グループ内のコンテナー。 |
Container[] (必須) |
| imageRegistryCredentials |
コンテナー グループの作成に使用されたイメージ レジストリの資格情報。 |
ImageRegistryCredential[] |
| ipAddress |
コンテナー グループの IP アドレスの種類。 |
IpAddress |
| osType |
コンテナー グループ内のコンテナーで必要なオペレーティング システムの種類。 |
'Linux'
'Windows' (必須) |
| restartPolicy |
コンテナー グループ内のすべてのコンテナーの再起動ポリシー。
- Always 常に再起動する
- OnFailure 失敗した場合の再起動
- Never 再起動しない |
'Always'
'Never'
'OnFailure' |
| volumes |
このコンテナー グループのコンテナーによってマウントできるボリュームのリスト。 |
Volume[] |
コンテナー
| 名前 |
説明 |
値 |
| name |
ユーザーが指定したコンテナー インスタンスの名前。 |
string (必須) |
| properties |
コンテナー インスタンスのプロパティ。 |
ContainerProperties (必須) |
ContainerProperties
| 名前 |
説明 |
値 |
| command |
コンテナー インスタンス内で実行する exec 形式のコマンド。 |
string[] |
| environmentVariables |
コンテナー インスタンス内で設定する環境変数。 |
EnvironmentVariable[] |
| image |
コンテナー インスタンスの作成に使用されるイメージの名前。 |
string (必須) |
| ports |
コンテナー インスタンスで公開されているポート。 |
ContainerPort[] |
| resources |
コンテナー インスタンスのリソース要件。 |
ResourceRequirements (必須) |
| volumeMounts |
コンテナー インスタンスで使用可能なボリューム マウント。 |
VolumeMount[] |
EnvironmentVariable
| 名前 |
説明 |
値 |
| name |
環境変数の名前。 |
string (必須) |
| value |
環境変数の値。 |
string (必須) |
ContainerPort
| 名前 |
説明 |
値 |
| port |
コンテナー グループ内で公開されているポート番号。 |
int (必須) |
| protocol |
ポートに関連付けられているプロトコル。 |
'TCP'
'UDP' |
ResourceRequirements
ResourceLimits
| 名前 |
説明 |
値 |
| cpu |
このコンテナー インスタンスの CPU 制限。 |
INT |
| memoryInGB |
このコンテナー インスタンスのメモリ制限 (GB 単位)。 10 進値を指定するには、 json() 関数を使用します。 |
int または json decimal |
ResourceRequests
| 名前 |
説明 |
値 |
| cpu |
このコンテナー インスタンスの CPU 要求。 |
int (必須) |
| memoryInGB |
このコンテナー インスタンスのメモリ要求 (GB 単位)。 10 進値を指定するには、 json() 関数を使用します。 |
int または json decimal (必須) |
VolumeMount
| 名前 |
説明 |
値 |
| mountPath |
ボリュームをマウントする必要があるコンテナー内のパス。 コロン (:) を含めることはできません。 |
string (必須) |
| name |
ボリューム マウントの名前。 |
string (必須) |
| readOnly |
ボリューム マウントが読み取り専用かどうかを示すフラグ。 |
[bool] |
ImageRegistryCredential
| 名前 |
説明 |
値 |
| password |
プライベート レジストリのパスワード。 |
string |
| server |
"http" や "https" などのプロトコルを除いた Docker イメージ レジストリ サーバー。 |
string (必須) |
| username |
プライベート レジストリのユーザー名。 |
string (必須) |
IpAddress
| 名前 |
説明 |
値 |
| dnsNameLabel |
IP の DNS 名ラベル。 |
string |
| ip |
パブリック インターネットに公開されている IP。 |
string |
| ports |
コンテナー グループで公開されているポートのリスト。 |
Port[] (必須) |
| 型 |
IP がパブリック インターネットに公開されるかどうかを指定します。 |
'Public' (必須) |
Port
| 名前 |
説明 |
値 |
| port |
ポート番号。 |
int (必須) |
| protocol |
ポートに関連付けられているプロトコル。 |
'TCP'
'UDP' |
ボリューム
| 名前 |
説明 |
値 |
| azureFile |
Azure File ボリューム。 |
AzureFileVolume |
| emptyDir |
空のディレクトリ ボリューム。 |
|
| gitRepo |
Git リポジトリ ボリューム。 |
GitRepoVolume |
| name |
ボリュームの名前。 |
string (必須) |
| secret |
シークレット ボリューム。 |
object |
AzureFileVolume
| 名前 |
説明 |
値 |
| readOnly |
ボリュームとしてマウントされている Azure ファイル共有が読み取り専用かどうかを示すフラグ。 |
[bool] |
| shareName |
ボリュームとしてマウントされる Azure ファイル共有の名前。 |
string (必須) |
| storageAccountKey |
Azure ファイル共有にアクセスするために使用されるストレージ アカウント アクセス キー。 |
string |
| storageAccountName |
Azure ファイル共有が含まれているストレージ アカウントの名前。 |
string (必須) |
GitRepoVolume
| 名前 |
説明 |
値 |
| directory |
ターゲット ディレクトリの名前。 ".." が含まれていたり、".." で始まっていたりすることはできません。 "." を指定した場合、ボリューム ディレクトリは Git リポジトリになります。 それ以外の場合、指定すると、ボリュームの指定された名前のサブディレクトリに Git リポジトリが含まれます。 |
string |
| repository |
リポジトリの URL |
string (必須) |
| revision |
指定されたリビジョンのコミット ハッシュ。 |
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
containerGroups リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.ContainerInstance/containerGroups リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2018-02-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
containers = [
{
name = "string"
properties = {
command = [
"string"
]
environmentVariables = [
{
name = "string"
value = "string"
}
]
image = "string"
ports = [
{
port = int
protocol = "string"
}
]
resources = {
limits = {
cpu = int
memoryInGB = "decimal-as-string"
}
requests = {
cpu = int
memoryInGB = "decimal-as-string"
}
}
volumeMounts = [
{
mountPath = "string"
name = "string"
readOnly = bool
}
]
}
}
]
imageRegistryCredentials = [
{
password = "string"
server = "string"
username = "string"
}
]
ipAddress = {
dnsNameLabel = "string"
ip = "string"
ports = [
{
port = int
protocol = "string"
}
]
type = "Public"
}
osType = "string"
restartPolicy = "string"
volumes = [
{
azureFile = {
readOnly = bool
shareName = "string"
storageAccountKey = "string"
storageAccountName = "string"
}
gitRepo = {
directory = "string"
repository = "string"
revision = "string"
}
name = "string"
secret = {}
}
]
}
})
}
プロパティ値
containerGroups
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
"Microsoft.ContainerInstance/containerGroups@2018-02-01-preview" |
| name |
リソース名 |
string (必須)
文字数制限: 1 から 63
有効な文字:
小文字、数字、およびハイフン。
先頭または末尾をハイフンにすることはできません。 連続するハイフンは使用できません。 |
| location |
リソースの場所。 |
string |
| parent_id |
リソース グループにデプロイするには、そのリソース グループの ID を使用します。 |
string (必須) |
| tags |
リソース タグ。 |
タグ名と値のディクショナリ。 |
| properties |
|
ContainerGroupProperties (必須) |
ContainerGroupProperties
| 名前 |
説明 |
値 |
| containers |
コンテナー グループ内のコンテナー。 |
Container[] (必須) |
| imageRegistryCredentials |
コンテナー グループの作成に使用されたイメージ レジストリの資格情報。 |
ImageRegistryCredential[] |
| ipAddress |
コンテナー グループの IP アドレスの種類。 |
IpAddress |
| osType |
コンテナー グループ内のコンテナーで必要なオペレーティング システムの種類。 |
"Linux"
"Windows" (必須) |
| restartPolicy |
コンテナー グループ内のすべてのコンテナーの再起動ポリシー。
- Always 常に再起動する
- OnFailure 失敗した場合の再起動
- Never 再起動しない |
"Always"
"Never"
"OnFailure" |
| volumes |
このコンテナー グループのコンテナーによってマウントできるボリュームのリスト。 |
Volume[] |
コンテナー
| 名前 |
説明 |
値 |
| name |
ユーザーが指定したコンテナー インスタンスの名前。 |
string (必須) |
| properties |
コンテナー インスタンスのプロパティ。 |
ContainerProperties (必須) |
ContainerProperties
| 名前 |
説明 |
値 |
| command |
コンテナー インスタンス内で実行する exec 形式のコマンド。 |
string[] |
| environmentVariables |
コンテナー インスタンス内で設定する環境変数。 |
EnvironmentVariable[] |
| image |
コンテナー インスタンスの作成に使用されるイメージの名前。 |
string (必須) |
| ports |
コンテナー インスタンスで公開されているポート。 |
ContainerPort[] |
| resources |
コンテナー インスタンスのリソース要件。 |
ResourceRequirements (必須) |
| volumeMounts |
コンテナー インスタンスで使用可能なボリューム マウント。 |
VolumeMount[] |
EnvironmentVariable
| 名前 |
説明 |
値 |
| name |
環境変数の名前。 |
string (必須) |
| value |
環境変数の値。 |
string (必須) |
ContainerPort
| 名前 |
説明 |
値 |
| port |
コンテナー グループ内で公開されているポート番号。 |
int (必須) |
| protocol |
ポートに関連付けられているプロトコル。 |
"TCP"
"UDP" |
ResourceRequirements
ResourceLimits
| 名前 |
説明 |
値 |
| cpu |
このコンテナー インスタンスの CPU 制限。 |
INT |
| memoryInGB |
このコンテナー インスタンスのメモリ制限 (GB 単位)。 10 進数の値を文字列として指定します。 |
int または json decimal |
ResourceRequests
| 名前 |
説明 |
値 |
| cpu |
このコンテナー インスタンスの CPU 要求。 |
int (必須) |
| memoryInGB |
このコンテナー インスタンスのメモリ要求 (GB 単位)。 10 進数の値を文字列として指定します。 |
int または json decimal (必須) |
VolumeMount
| 名前 |
説明 |
値 |
| mountPath |
ボリュームをマウントする必要があるコンテナー内のパス。 コロン (:) を含めることはできません。 |
string (必須) |
| name |
ボリューム マウントの名前。 |
string (必須) |
| readOnly |
ボリューム マウントが読み取り専用かどうかを示すフラグ。 |
[bool] |
ImageRegistryCredential
| 名前 |
説明 |
値 |
| password |
プライベート レジストリのパスワード。 |
string |
| server |
"http" や "https" などのプロトコルを除いた Docker イメージ レジストリ サーバー。 |
string (必須) |
| username |
プライベート レジストリのユーザー名。 |
string (必須) |
IpAddress
| 名前 |
説明 |
値 |
| dnsNameLabel |
IP の DNS 名ラベル。 |
string |
| ip |
パブリック インターネットに公開されている IP。 |
string |
| ports |
コンテナー グループで公開されているポートのリスト。 |
Port[] (必須) |
| 型 |
IP がパブリック インターネットに公開されるかどうかを指定します。 |
"Public" (必須) |
Port
| 名前 |
説明 |
値 |
| port |
ポート番号。 |
int (必須) |
| protocol |
ポートに関連付けられているプロトコル。 |
"TCP"
"UDP" |
ボリューム
| 名前 |
説明 |
値 |
| azureFile |
Azure File ボリューム。 |
AzureFileVolume |
| emptyDir |
空のディレクトリ ボリューム。 |
|
| gitRepo |
Git リポジトリ ボリューム。 |
GitRepoVolume |
| name |
ボリュームの名前。 |
string (必須) |
| secret |
シークレット ボリューム。 |
object |
AzureFileVolume
| 名前 |
説明 |
値 |
| readOnly |
ボリュームとしてマウントされている Azure ファイル共有が読み取り専用かどうかを示すフラグ。 |
[bool] |
| shareName |
ボリュームとしてマウントされる Azure ファイル共有の名前。 |
string (必須) |
| storageAccountKey |
Azure ファイル共有にアクセスするために使用されるストレージ アカウント アクセス キー。 |
string |
| storageAccountName |
Azure ファイル共有が含まれているストレージ アカウントの名前。 |
string (必須) |
GitRepoVolume
| 名前 |
説明 |
値 |
| directory |
ターゲット ディレクトリの名前。 ".." が含まれていたり、".." で始まっていたりすることはできません。 "." を指定した場合、ボリューム ディレクトリは Git リポジトリになります。 それ以外の場合、指定すると、ボリュームの指定された名前のサブディレクトリに Git リポジトリが含まれます。 |
string |
| repository |
リポジトリの URL |
string (必須) |
| revision |
指定されたリビジョンのコミット ハッシュ。 |
string |
