Определение ресурсов Bicep
Тип ресурса containerGroups можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.ContainerInstance/containerGroups, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2017-08-01-preview' = {
location: 'string'
name: 'string'
properties: {
containers: [
{
name: 'string'
properties: {
command: [
'string'
]
environmentVariables: [
{
name: 'string'
value: 'string'
}
]
image: 'string'
ports: [
{
port: int
}
]
resources: {
limits: {
cpu: int
memoryInGB: int
}
requests: {
cpu: int
memoryInGB: int
}
}
volumeMounts: [
{
mountPath: 'string'
name: 'string'
readOnly: bool
}
]
}
}
]
imageRegistryCredentials: [
{
password: 'string'
server: 'string'
username: 'string'
}
]
ipAddress: {
ip: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
type: 'string'
}
osType: 'string'
restartPolicy: 'string'
volumes: [
{
azureFile: {
readOnly: bool
shareName: 'string'
storageAccountKey: 'string'
storageAccountName: 'string'
}
name: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
AzureFileVolume
Имя |
Описание |
Ценность |
readOnly |
Флаг, указывающий, подключен ли общий файл Azure в качестве тома только для чтения. |
булевая переменная (bool) |
shareName |
Имя общей папки Azure, подключенной в качестве тома. |
строка (обязательно) |
ключХранилищаАккаунта |
Ключ доступа к учетной записи хранения, используемый для доступа к общей папке Azure. |
струна |
storageAccountName |
Имя учетной записи хранения, содержащей общую папку Azure. |
строка (обязательно) |
Контейнер
Имя |
Описание |
Ценность |
имя |
Имя экземпляра контейнера, предоставленное пользователем. |
строка (обязательно) |
свойства |
Свойства экземпляра контейнера. |
ContainerProperties (обязательно) |
ContainerGroupProperties
Имя |
Описание |
Ценность |
Контейнеры |
Контейнеры в группе контейнеров. |
контейнер[] (обязательно) |
imageRegistryCredentials |
Учетные данные реестра образов, из которых создается группа контейнеров. |
ImageRegistryCredential[] |
ipAddress |
Тип IP-адреса группы контейнеров. |
IpAddress |
Тип ОС |
Тип операционной системы, необходимый контейнерам в группе контейнеров. |
Linux "Windows" (обязательно) |
политика перезапуска |
Перезапустите политику для всех контейнеров в группе контейнеров. В настоящее время единственным доступным вариантом является always . |
"всегда" |
Объемы |
Список томов, которые могут быть подключены контейнерами в этой группе контейнеров. |
тома[] |
ContainerPort
Имя |
Описание |
Ценность |
порт |
Номер порта, предоставляемый в группе контейнеров. |
int (обязательно) |
СвойстваКонтейнера
Имя |
Описание |
Ценность |
команда |
Команды, выполняемые в экземпляре контейнера в форме exec. |
строка[] |
переменные окружения |
Переменные среды, заданные в экземпляре контейнера. |
EnvironmentVariable[] |
образ |
Имя образа, используемого для создания экземпляра контейнера. |
строка (обязательно) |
Порты |
Предоставленные порты в экземпляре контейнера. |
ContainerPort[] |
ресурсы |
Требования к ресурсам экземпляра контейнера. |
ResourceRequirements (обязательно) |
volumeMounts |
Том подключается к экземпляру контейнера. |
VolumeMount[] |
EnvironmentVariable
Имя |
Описание |
Ценность |
имя |
Имя переменной среды. |
строка (обязательно) |
ценность |
Значение переменной среды. |
строка (обязательно) |
ImageRegistryCredential
Имя |
Описание |
Ценность |
пароль |
Пароль для частного реестра. |
струна |
сервер |
Сервер реестра образов Docker без протокола, например http и https. |
строка (обязательно) |
имя пользователя |
Имя пользователя для частного реестра. |
строка (обязательно) |
IP-адрес
Имя |
Описание |
Ценность |
протокол IP |
IP-адрес, предоставляемый общедоступному Интернету. |
струна |
Порты |
Список портов, предоставляемых в группе контейнеров. |
порт[] (обязательно) |
тип |
Указывает, предоставляется ли IP-адрес общедоступному Интернету. |
"Public" (обязательно) |
Microsoft.ContainerInstance/containerGroups
Имя |
Описание |
Ценность |
местоположение |
Расположение ресурса. |
строка (обязательно) |
имя |
Имя ресурса |
строка (обязательно) |
свойства |
|
ContainerGroupProperties (обязательно) |
Теги |
Теги ресурсов |
Словарь имен и значений тегов. См. теги в шаблонах |
Порт
Имя |
Описание |
Ценность |
порт |
Номер порта. |
int (обязательно) |
протокол |
Протокол, связанный с портом. |
"TCP" "UDP" |
ResourceLimits
Имя |
Описание |
Ценность |
ЦПУ |
Ограничение ЦП этого экземпляра контейнера. |
инт |
memoryInGB |
Ограничение памяти в ГБ этого экземпляра контейнера. |
инт |
ResourceRequests
Имя |
Описание |
Ценность |
ЦПУ |
Запрос ЦП этого экземпляра контейнера. |
int (обязательно) |
memoryInGB |
Запрос памяти в ГБ этого экземпляра контейнера. |
int (обязательно) |
ResourceRequirements
Имя |
Описание |
Ценность |
Ограничения |
Ограничения ресурсов этого экземпляра контейнера. |
ResourceLimits |
Запросы |
Запросы ресурсов этого экземпляра контейнера. |
ResourceRequests (обязательно) |
Том
Имя |
Описание |
Ценность |
azureFile |
Имя тома файла Azure. |
AzureFileVolume (обязательно) |
имя |
Имя тома. |
строка (обязательно) |
VolumeMount
Имя |
Описание |
Ценность |
mountPath |
Путь в контейнере, в котором должен быть подключен том. Не должен содержать двоеточие (:). |
строка (обязательно) |
имя |
Имя подключения тома. |
строка (обязательно) |
readOnly |
Флаг, указывающий, доступен ли подключение тома только для чтения. |
булевая переменная (bool) |
Примеры использования
Проверенные модули Azure
Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.
Примеры быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.
Определение ресурса шаблона ARM
Тип ресурса containerGroups можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.ContainerInstance/containerGroups, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2017-08-01-preview",
"name": "string",
"location": "string",
"properties": {
"containers": [
{
"name": "string",
"properties": {
"command": [ "string" ],
"environmentVariables": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"ports": [
{
"port": "int"
}
],
"resources": {
"limits": {
"cpu": "int",
"memoryInGB": "int"
},
"requests": {
"cpu": "int",
"memoryInGB": "int"
}
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": "bool"
}
]
}
}
],
"imageRegistryCredentials": [
{
"password": "string",
"server": "string",
"username": "string"
}
],
"ipAddress": {
"ip": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"type": "string"
},
"osType": "string",
"restartPolicy": "string",
"volumes": [
{
"azureFile": {
"readOnly": "bool",
"shareName": "string",
"storageAccountKey": "string",
"storageAccountName": "string"
},
"name": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
AzureFileVolume
Имя |
Описание |
Ценность |
readOnly |
Флаг, указывающий, подключен ли общий файл Azure в качестве тома только для чтения. |
булевая переменная (bool) |
shareName |
Имя общей папки Azure, подключенной в качестве тома. |
строка (обязательно) |
ключХранилищаАккаунта |
Ключ доступа к учетной записи хранения, используемый для доступа к общей папке Azure. |
струна |
storageAccountName |
Имя учетной записи хранения, содержащей общую папку Azure. |
строка (обязательно) |
Контейнер
Имя |
Описание |
Ценность |
имя |
Имя экземпляра контейнера, предоставленное пользователем. |
строка (обязательно) |
свойства |
Свойства экземпляра контейнера. |
ContainerProperties (обязательно) |
ContainerGroupProperties
Имя |
Описание |
Ценность |
Контейнеры |
Контейнеры в группе контейнеров. |
контейнер[] (обязательно) |
imageRegistryCredentials |
Учетные данные реестра образов, из которых создается группа контейнеров. |
ImageRegistryCredential[] |
ipAddress |
Тип IP-адреса группы контейнеров. |
IpAddress |
Тип ОС |
Тип операционной системы, необходимый контейнерам в группе контейнеров. |
Linux "Windows" (обязательно) |
политика перезапуска |
Перезапустите политику для всех контейнеров в группе контейнеров. В настоящее время единственным доступным вариантом является always . |
"всегда" |
Объемы |
Список томов, которые могут быть подключены контейнерами в этой группе контейнеров. |
тома[] |
ContainerPort
Имя |
Описание |
Ценность |
порт |
Номер порта, предоставляемый в группе контейнеров. |
int (обязательно) |
СвойстваКонтейнера
Имя |
Описание |
Ценность |
команда |
Команды, выполняемые в экземпляре контейнера в форме exec. |
строка[] |
переменные окружения |
Переменные среды, заданные в экземпляре контейнера. |
EnvironmentVariable[] |
образ |
Имя образа, используемого для создания экземпляра контейнера. |
строка (обязательно) |
Порты |
Предоставленные порты в экземпляре контейнера. |
ContainerPort[] |
ресурсы |
Требования к ресурсам экземпляра контейнера. |
ResourceRequirements (обязательно) |
volumeMounts |
Том подключается к экземпляру контейнера. |
VolumeMount[] |
EnvironmentVariable
Имя |
Описание |
Ценность |
имя |
Имя переменной среды. |
строка (обязательно) |
ценность |
Значение переменной среды. |
строка (обязательно) |
ImageRegistryCredential
Имя |
Описание |
Ценность |
пароль |
Пароль для частного реестра. |
струна |
сервер |
Сервер реестра образов Docker без протокола, например http и https. |
строка (обязательно) |
имя пользователя |
Имя пользователя для частного реестра. |
строка (обязательно) |
IP-адрес
Имя |
Описание |
Ценность |
протокол IP |
IP-адрес, предоставляемый общедоступному Интернету. |
струна |
Порты |
Список портов, предоставляемых в группе контейнеров. |
порт[] (обязательно) |
тип |
Указывает, предоставляется ли IP-адрес общедоступному Интернету. |
"Public" (обязательно) |
Microsoft.ContainerInstance/containerGroups
Имя |
Описание |
Ценность |
apiVersion |
Версия API |
'2017-08-01-preview' |
местоположение |
Расположение ресурса. |
строка (обязательно) |
имя |
Имя ресурса |
строка (обязательно) |
свойства |
|
ContainerGroupProperties (обязательно) |
Теги |
Теги ресурсов |
Словарь имен и значений тегов. См. теги в шаблонах |
тип |
Тип ресурса |
"Microsoft.ContainerInstance/containerGroups" |
Порт
Имя |
Описание |
Ценность |
порт |
Номер порта. |
int (обязательно) |
протокол |
Протокол, связанный с портом. |
"TCP" "UDP" |
ResourceLimits
Имя |
Описание |
Ценность |
ЦПУ |
Ограничение ЦП этого экземпляра контейнера. |
инт |
memoryInGB |
Ограничение памяти в ГБ этого экземпляра контейнера. |
инт |
ResourceRequests
Имя |
Описание |
Ценность |
ЦПУ |
Запрос ЦП этого экземпляра контейнера. |
int (обязательно) |
memoryInGB |
Запрос памяти в ГБ этого экземпляра контейнера. |
int (обязательно) |
ResourceRequirements
Имя |
Описание |
Ценность |
Ограничения |
Ограничения ресурсов этого экземпляра контейнера. |
ResourceLimits |
Запросы |
Запросы ресурсов этого экземпляра контейнера. |
ResourceRequests (обязательно) |
Том
Имя |
Описание |
Ценность |
azureFile |
Имя тома файла Azure. |
AzureFileVolume (обязательно) |
имя |
Имя тома. |
строка (обязательно) |
VolumeMount
Имя |
Описание |
Ценность |
mountPath |
Путь в контейнере, в котором должен быть подключен том. Не должен содержать двоеточие (:). |
строка (обязательно) |
имя |
Имя подключения тома. |
строка (обязательно) |
readOnly |
Флаг, указывающий, доступен ли подключение тома только для чтения. |
булевая переменная (bool) |
Примеры использования
Шаблоны быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.
Тип ресурса containerGroups можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Чтобы создать ресурс Microsoft.ContainerInstance/containerGroups, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2017-08-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
containers = [
{
name = "string"
properties = {
command = [
"string"
]
environmentVariables = [
{
name = "string"
value = "string"
}
]
image = "string"
ports = [
{
port = int
}
]
resources = {
limits = {
cpu = int
memoryInGB = int
}
requests = {
cpu = int
memoryInGB = int
}
}
volumeMounts = [
{
mountPath = "string"
name = "string"
readOnly = bool
}
]
}
}
]
imageRegistryCredentials = [
{
password = "string"
server = "string"
username = "string"
}
]
ipAddress = {
ip = "string"
ports = [
{
port = int
protocol = "string"
}
]
type = "string"
}
osType = "string"
restartPolicy = "string"
volumes = [
{
azureFile = {
readOnly = bool
shareName = "string"
storageAccountKey = "string"
storageAccountName = "string"
}
name = "string"
}
]
}
}
}
Значения свойств
AzureFileVolume
Имя |
Описание |
Ценность |
readOnly |
Флаг, указывающий, подключен ли общий файл Azure в качестве тома только для чтения. |
булевая переменная (bool) |
shareName |
Имя общей папки Azure, подключенной в качестве тома. |
строка (обязательно) |
ключХранилищаАккаунта |
Ключ доступа к учетной записи хранения, используемый для доступа к общей папке Azure. |
струна |
storageAccountName |
Имя учетной записи хранения, содержащей общую папку Azure. |
строка (обязательно) |
Контейнер
Имя |
Описание |
Ценность |
имя |
Имя экземпляра контейнера, предоставленное пользователем. |
строка (обязательно) |
свойства |
Свойства экземпляра контейнера. |
ContainerProperties (обязательно) |
ContainerGroupProperties
Имя |
Описание |
Ценность |
Контейнеры |
Контейнеры в группе контейнеров. |
контейнер[] (обязательно) |
imageRegistryCredentials |
Учетные данные реестра образов, из которых создается группа контейнеров. |
ImageRegistryCredential[] |
ipAddress |
Тип IP-адреса группы контейнеров. |
IpAddress |
Тип ОС |
Тип операционной системы, необходимый контейнерам в группе контейнеров. |
Linux "Windows" (обязательно) |
политика перезапуска |
Перезапустите политику для всех контейнеров в группе контейнеров. В настоящее время единственным доступным вариантом является always . |
"всегда" |
Объемы |
Список томов, которые могут быть подключены контейнерами в этой группе контейнеров. |
тома[] |
ContainerPort
Имя |
Описание |
Ценность |
порт |
Номер порта, предоставляемый в группе контейнеров. |
int (обязательно) |
СвойстваКонтейнера
Имя |
Описание |
Ценность |
команда |
Команды, выполняемые в экземпляре контейнера в форме exec. |
строка[] |
переменные окружения |
Переменные среды, заданные в экземпляре контейнера. |
EnvironmentVariable[] |
образ |
Имя образа, используемого для создания экземпляра контейнера. |
строка (обязательно) |
Порты |
Предоставленные порты в экземпляре контейнера. |
ContainerPort[] |
ресурсы |
Требования к ресурсам экземпляра контейнера. |
ResourceRequirements (обязательно) |
volumeMounts |
Том подключается к экземпляру контейнера. |
VolumeMount[] |
EnvironmentVariable
Имя |
Описание |
Ценность |
имя |
Имя переменной среды. |
строка (обязательно) |
ценность |
Значение переменной среды. |
строка (обязательно) |
ImageRegistryCredential
Имя |
Описание |
Ценность |
пароль |
Пароль для частного реестра. |
струна |
сервер |
Сервер реестра образов Docker без протокола, например http и https. |
строка (обязательно) |
имя пользователя |
Имя пользователя для частного реестра. |
строка (обязательно) |
IP-адрес
Имя |
Описание |
Ценность |
протокол IP |
IP-адрес, предоставляемый общедоступному Интернету. |
струна |
Порты |
Список портов, предоставляемых в группе контейнеров. |
порт[] (обязательно) |
тип |
Указывает, предоставляется ли IP-адрес общедоступному Интернету. |
"Public" (обязательно) |
Microsoft.ContainerInstance/containerGroups
Имя |
Описание |
Ценность |
местоположение |
Расположение ресурса. |
строка (обязательно) |
имя |
Имя ресурса |
строка (обязательно) |
свойства |
|
ContainerGroupProperties (обязательно) |
Теги |
Теги ресурсов |
Словарь имен и значений тегов. |
тип |
Тип ресурса |
"Microsoft.ContainerInstance/containerGroups@2017-08-01-preview" |
Порт
Имя |
Описание |
Ценность |
порт |
Номер порта. |
int (обязательно) |
протокол |
Протокол, связанный с портом. |
"TCP" "UDP" |
ResourceLimits
Имя |
Описание |
Ценность |
ЦПУ |
Ограничение ЦП этого экземпляра контейнера. |
инт |
memoryInGB |
Ограничение памяти в ГБ этого экземпляра контейнера. |
инт |
ResourceRequests
Имя |
Описание |
Ценность |
ЦПУ |
Запрос ЦП этого экземпляра контейнера. |
int (обязательно) |
memoryInGB |
Запрос памяти в ГБ этого экземпляра контейнера. |
int (обязательно) |
ResourceRequirements
Имя |
Описание |
Ценность |
Ограничения |
Ограничения ресурсов этого экземпляра контейнера. |
ResourceLimits |
Запросы |
Запросы ресурсов этого экземпляра контейнера. |
ResourceRequests (обязательно) |
Том
Имя |
Описание |
Ценность |
azureFile |
Имя тома файла Azure. |
AzureFileVolume (обязательно) |
имя |
Имя тома. |
строка (обязательно) |
VolumeMount
Имя |
Описание |
Ценность |
mountPath |
Путь в контейнере, в котором должен быть подключен том. Не должен содержать двоеточие (:). |
строка (обязательно) |
имя |
Имя подключения тома. |
строка (обязательно) |
readOnly |
Флаг, указывающий, доступен ли подключение тома только для чтения. |
булевая переменная (bool) |
Примеры использования
Проверенные модули Azure
Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.