Microsoft.ContainerInstance containerGroups 2017-12-01-preview
Artykuł 12/22/2024
Współautorzy: 2
Opinia
W tym artykule
Definicja zasobu Bicep
Typ zasobu containerGroups można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian .
Aby utworzyć zasób Microsoft.ContainerInstance/containerGroups, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2017-12-01-preview' = {
location: 'string'
name: 'string'
properties: {
containers: [
{
name: 'string'
properties: {
command: [
'string'
]
environmentVariables: [
{
name: 'string'
value: 'string'
}
]
image: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
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'
}
emptyDir: any(Azure.Bicep.Types.Concrete.AnyType)
gitRepo: {
directory: 'string'
repository: 'string'
revision: 'string'
}
name: 'string'
secret: {
{customized property}: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
Wartości właściwości
AzureFileVolume
Nazwa
Opis
Wartość
readOnly
Flaga wskazująca, czy udostępniony plik platformy Azure zainstalowany jako wolumin jest tylko do odczytu.
Bool
shareName
Nazwa udziału plików platformy Azure, który ma zostać zainstalowany jako wolumin.
ciąg (wymagany)
storageAccountKey
Klucz dostępu konta magazynu używany do uzyskiwania dostępu do udziału plików platformy Azure.
struna
storageAccountName
Nazwa konta magazynu zawierającego udział plików platformy Azure.
ciąg (wymagany)
Kontener
Nazwa
Opis
Wartość
nazwa
Podana przez użytkownika nazwa wystąpienia kontenera.
ciąg (wymagany)
Właściwości
Właściwości wystąpienia kontenera.
ContainerProperties (wymagane)
ContainerGroupProperties
Nazwa
Opis
Wartość
Pojemniki
Kontenery w grupie kontenerów.
Container [] (wymagane)
imageRegistryCredentials
Poświadczenia rejestru obrazów, na podstawie których jest tworzona grupa kontenerów.
ImageRegistryCredential []
ipAddress
Typ adresu IP grupy kontenerów.
IpAddress
osType
Typ systemu operacyjnego wymagany przez kontenery w grupie kontenerów.
"Linux" "Windows" (wymagane)
restartPolicy
Uruchom ponownie zasady dla wszystkich kontenerów w grupie kontenerów.
-
Always
Zawsze uruchamiaj ponownie
-
OnFailure
ponowne uruchomienie po awarii
-
Never
Nigdy nie uruchamiaj ponownie
"Zawsze" "Nigdy" "OnFailure"
Woluminów
Lista woluminów, które mogą być instalowane przez kontenery w tej grupie kontenerów.
woluminu []
ContainerPort
Nazwa
Opis
Wartość
port
Numer portu uwidoczniony w grupie kontenerów.
int (wymagane)
protokół
Protokół skojarzony z portem.
"TCP" "UDP"
ContainerProperties
Nazwa
Opis
Wartość
polecenie
Polecenia do wykonania w ramach wystąpienia kontenera w formularzu exec.
string[]
environmentVariables
Zmienne środowiskowe do ustawienia w wystąpieniu kontenera.
EnvironmentVariable []
obraz
Nazwa obrazu użytego do utworzenia wystąpienia kontenera.
ciąg (wymagany)
Porty
Uwidocznione porty w wystąpieniu kontenera.
ContainerPort []
zasoby
Wymagania dotyczące zasobów wystąpienia kontenera.
ResourceRequirements (wymagane)
volumeMounts
Woluminy są montowane w wystąpieniu kontenera.
volumeMount []
Zmienna środowiskowa
Nazwa
Opis
Wartość
nazwa
Nazwa zmiennej środowiskowej.
ciąg (wymagany)
wartość
Wartość zmiennej środowiskowej.
ciąg (wymagany)
GitRepoVolume
Nazwa
Opis
Wartość
katalog
Nazwa katalogu docelowego. Nie może zawierać ani rozpoczynać się od ".". Jeśli element "." zostanie dostarczony, katalog woluminu będzie repozytorium git. W przeciwnym razie, jeśli zostanie określony, wolumin będzie zawierać repozytorium git w podkatalogu o podanej nazwie.
struna
repozytorium
Adres URL repozytorium
ciąg (wymagany)
rewizja
Zatwierdź skrót dla określonej poprawki.
struna
ImageRegistryCredential
Nazwa
Opis
Wartość
hasło
Hasło dla rejestru prywatnego.
struna
serwer
Serwer rejestru obrazów platformy Docker bez protokołu, takiego jak "http" i "https".
ciąg (wymagany)
nazwa użytkownika
Nazwa użytkownika rejestru prywatnego.
ciąg (wymagany)
Adresy IP
Nazwa
Opis
Wartość
Ip
Adres IP uwidoczniony w publicznym Internecie.
struna
Porty
Lista portów uwidocznionych w grupie kontenerów.
port [] (wymagane)
typ
Określa, czy adres IP jest uwidoczniony w publicznym Internecie.
"Publiczny" (wymagany)
Microsoft.ContainerInstance/containerGroups
Nazwa
Opis
Wartość
lokalizacja
Lokalizacja zasobu.
ciąg (wymagany)
nazwa
Nazwa zasobu
ciąg (wymagany)
Właściwości
ContainerGroupProperties (wymagane)
Tagi
Tagi zasobów
Słownik nazw tagów i wartości. Zobacz tagi w szablonach
Port
Nazwa
Opis
Wartość
port
Numer portu.
int (wymagane)
protokół
Protokół skojarzony z portem.
"TCP" "UDP"
ZasobyLimits
Nazwa
Opis
Wartość
procesor
Limit procesora CPU dla tego wystąpienia kontenera.
Int
memoryInGB
Limit pamięci w GB tego wystąpienia kontenera.
Int
ResourceRequests
Nazwa
Opis
Wartość
procesor
Żądanie procesora CPU tego wystąpienia kontenera.
int (wymagane)
memoryInGB
Żądanie pamięci w GB tego wystąpienia kontenera.
int (wymagane)
Wymagania dotyczące zasobów
Nazwa
Opis
Wartość
Limity
Limity zasobów tego wystąpienia kontenera.
ResourceLimits
Żądania
Zasób żąda tego wystąpienia kontenera.
ResourceRequests (wymagane)
SecretVolume
Głośność
Nazwa
Opis
Wartość
azureFile
Wolumin usługi Azure File.
AzureFileVolume
emptyDir
Pusty wolumin katalogu.
jakikolwiek
gitRepo
Wolumin repozytorium git.
GitRepoVolume
nazwa
Nazwa woluminu.
ciąg (wymagany)
tajny
Wolumin tajny.
SecretVolume
WoluminMount
Nazwa
Opis
Wartość
mountPath
Ścieżka w kontenerze, w którym należy zamontować wolumin. Nie może zawierać dwukropka (:).
ciąg (wymagany)
nazwa
Nazwa instalacji woluminu.
ciąg (wymagany)
readOnly
Flaga wskazująca, czy instalacja woluminu jest tylko do odczytu.
Bool
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.
Definicja zasobu szablonu usługi ARM
Typ zasobu containerGroups można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian .
Aby utworzyć zasób Microsoft.ContainerInstance/containerGroups, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2017-12-01-preview",
"name": "string",
"location": "string",
"properties": {
"containers": [
{
"name": "string",
"properties": {
"command": [ "string" ],
"environmentVariables": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"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"
},
"emptyDir": {},
"gitRepo": {
"directory": "string",
"repository": "string",
"revision": "string"
},
"name": "string",
"secret": {
"{customized property}": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
Wartości właściwości
AzureFileVolume
Nazwa
Opis
Wartość
readOnly
Flaga wskazująca, czy udostępniony plik platformy Azure zainstalowany jako wolumin jest tylko do odczytu.
Bool
shareName
Nazwa udziału plików platformy Azure, który ma zostać zainstalowany jako wolumin.
ciąg (wymagany)
storageAccountKey
Klucz dostępu konta magazynu używany do uzyskiwania dostępu do udziału plików platformy Azure.
struna
storageAccountName
Nazwa konta magazynu zawierającego udział plików platformy Azure.
ciąg (wymagany)
Kontener
Nazwa
Opis
Wartość
nazwa
Podana przez użytkownika nazwa wystąpienia kontenera.
ciąg (wymagany)
Właściwości
Właściwości wystąpienia kontenera.
ContainerProperties (wymagane)
ContainerGroupProperties
Nazwa
Opis
Wartość
Pojemniki
Kontenery w grupie kontenerów.
Container [] (wymagane)
imageRegistryCredentials
Poświadczenia rejestru obrazów, na podstawie których jest tworzona grupa kontenerów.
ImageRegistryCredential []
ipAddress
Typ adresu IP grupy kontenerów.
IpAddress
osType
Typ systemu operacyjnego wymagany przez kontenery w grupie kontenerów.
"Linux" "Windows" (wymagane)
restartPolicy
Uruchom ponownie zasady dla wszystkich kontenerów w grupie kontenerów.
-
Always
Zawsze uruchamiaj ponownie
-
OnFailure
ponowne uruchomienie po awarii
-
Never
Nigdy nie uruchamiaj ponownie
"Zawsze" "Nigdy" "OnFailure"
Woluminów
Lista woluminów, które mogą być instalowane przez kontenery w tej grupie kontenerów.
woluminu []
ContainerPort
Nazwa
Opis
Wartość
port
Numer portu uwidoczniony w grupie kontenerów.
int (wymagane)
protokół
Protokół skojarzony z portem.
"TCP" "UDP"
ContainerProperties
Nazwa
Opis
Wartość
polecenie
Polecenia do wykonania w ramach wystąpienia kontenera w formularzu exec.
string[]
environmentVariables
Zmienne środowiskowe do ustawienia w wystąpieniu kontenera.
EnvironmentVariable []
obraz
Nazwa obrazu użytego do utworzenia wystąpienia kontenera.
ciąg (wymagany)
Porty
Uwidocznione porty w wystąpieniu kontenera.
ContainerPort []
zasoby
Wymagania dotyczące zasobów wystąpienia kontenera.
ResourceRequirements (wymagane)
volumeMounts
Woluminy są montowane w wystąpieniu kontenera.
volumeMount []
Zmienna środowiskowa
Nazwa
Opis
Wartość
nazwa
Nazwa zmiennej środowiskowej.
ciąg (wymagany)
wartość
Wartość zmiennej środowiskowej.
ciąg (wymagany)
GitRepoVolume
Nazwa
Opis
Wartość
katalog
Nazwa katalogu docelowego. Nie może zawierać ani rozpoczynać się od ".". Jeśli element "." zostanie dostarczony, katalog woluminu będzie repozytorium git. W przeciwnym razie, jeśli zostanie określony, wolumin będzie zawierać repozytorium git w podkatalogu o podanej nazwie.
struna
repozytorium
Adres URL repozytorium
ciąg (wymagany)
rewizja
Zatwierdź skrót dla określonej poprawki.
struna
ImageRegistryCredential
Nazwa
Opis
Wartość
hasło
Hasło dla rejestru prywatnego.
struna
serwer
Serwer rejestru obrazów platformy Docker bez protokołu, takiego jak "http" i "https".
ciąg (wymagany)
nazwa użytkownika
Nazwa użytkownika rejestru prywatnego.
ciąg (wymagany)
Adresy IP
Nazwa
Opis
Wartość
Ip
Adres IP uwidoczniony w publicznym Internecie.
struna
Porty
Lista portów uwidocznionych w grupie kontenerów.
port [] (wymagane)
typ
Określa, czy adres IP jest uwidoczniony w publicznym Internecie.
"Publiczny" (wymagany)
Microsoft.ContainerInstance/containerGroups
Nazwa
Opis
Wartość
apiVersion
Wersja interfejsu API
"2017-12-01-preview"
lokalizacja
Lokalizacja zasobu.
ciąg (wymagany)
nazwa
Nazwa zasobu
ciąg (wymagany)
Właściwości
ContainerGroupProperties (wymagane)
Tagi
Tagi zasobów
Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ
Typ zasobu
"Microsoft.ContainerInstance/containerGroups"
Port
Nazwa
Opis
Wartość
port
Numer portu.
int (wymagane)
protokół
Protokół skojarzony z portem.
"TCP" "UDP"
ZasobyLimits
Nazwa
Opis
Wartość
procesor
Limit procesora CPU dla tego wystąpienia kontenera.
Int
memoryInGB
Limit pamięci w GB tego wystąpienia kontenera.
Int
ResourceRequests
Nazwa
Opis
Wartość
procesor
Żądanie procesora CPU tego wystąpienia kontenera.
int (wymagane)
memoryInGB
Żądanie pamięci w GB tego wystąpienia kontenera.
int (wymagane)
Wymagania dotyczące zasobów
Nazwa
Opis
Wartość
Limity
Limity zasobów tego wystąpienia kontenera.
ResourceLimits
Żądania
Zasób żąda tego wystąpienia kontenera.
ResourceRequests (wymagane)
SecretVolume
Głośność
Nazwa
Opis
Wartość
azureFile
Wolumin usługi Azure File.
AzureFileVolume
emptyDir
Pusty wolumin katalogu.
jakikolwiek
gitRepo
Wolumin repozytorium git.
GitRepoVolume
nazwa
Nazwa woluminu.
ciąg (wymagany)
tajny
Wolumin tajny.
SecretVolume
WoluminMount
Nazwa
Opis
Wartość
mountPath
Ścieżka w kontenerze, w którym należy zamontować wolumin. Nie może zawierać dwukropka (:).
ciąg (wymagany)
nazwa
Nazwa instalacji woluminu.
ciąg (wymagany)
readOnly
Flaga wskazująca, czy instalacja woluminu jest tylko do odczytu.
Bool
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Typ zasobu containerGroups można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian .
Aby utworzyć zasób Microsoft.ContainerInstance/containerGroups, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2017-12-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
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 = 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"
}
emptyDir = ?
gitRepo = {
directory = "string"
repository = "string"
revision = "string"
}
name = "string"
secret = {
{customized property} = "string"
}
}
]
}
})
}
Wartości właściwości
AzureFileVolume
Nazwa
Opis
Wartość
readOnly
Flaga wskazująca, czy udostępniony plik platformy Azure zainstalowany jako wolumin jest tylko do odczytu.
Bool
shareName
Nazwa udziału plików platformy Azure, który ma zostać zainstalowany jako wolumin.
ciąg (wymagany)
storageAccountKey
Klucz dostępu konta magazynu używany do uzyskiwania dostępu do udziału plików platformy Azure.
struna
storageAccountName
Nazwa konta magazynu zawierającego udział plików platformy Azure.
ciąg (wymagany)
Kontener
Nazwa
Opis
Wartość
nazwa
Podana przez użytkownika nazwa wystąpienia kontenera.
ciąg (wymagany)
Właściwości
Właściwości wystąpienia kontenera.
ContainerProperties (wymagane)
ContainerGroupProperties
Nazwa
Opis
Wartość
Pojemniki
Kontenery w grupie kontenerów.
Container [] (wymagane)
imageRegistryCredentials
Poświadczenia rejestru obrazów, na podstawie których jest tworzona grupa kontenerów.
ImageRegistryCredential []
ipAddress
Typ adresu IP grupy kontenerów.
IpAddress
osType
Typ systemu operacyjnego wymagany przez kontenery w grupie kontenerów.
"Linux" "Windows" (wymagane)
restartPolicy
Uruchom ponownie zasady dla wszystkich kontenerów w grupie kontenerów.
-
Always
Zawsze uruchamiaj ponownie
-
OnFailure
ponowne uruchomienie po awarii
-
Never
Nigdy nie uruchamiaj ponownie
"Zawsze" "Nigdy" "OnFailure"
Woluminów
Lista woluminów, które mogą być instalowane przez kontenery w tej grupie kontenerów.
woluminu []
ContainerPort
Nazwa
Opis
Wartość
port
Numer portu uwidoczniony w grupie kontenerów.
int (wymagane)
protokół
Protokół skojarzony z portem.
"TCP" "UDP"
ContainerProperties
Nazwa
Opis
Wartość
polecenie
Polecenia do wykonania w ramach wystąpienia kontenera w formularzu exec.
string[]
environmentVariables
Zmienne środowiskowe do ustawienia w wystąpieniu kontenera.
EnvironmentVariable []
obraz
Nazwa obrazu użytego do utworzenia wystąpienia kontenera.
ciąg (wymagany)
Porty
Uwidocznione porty w wystąpieniu kontenera.
ContainerPort []
zasoby
Wymagania dotyczące zasobów wystąpienia kontenera.
ResourceRequirements (wymagane)
volumeMounts
Woluminy są montowane w wystąpieniu kontenera.
volumeMount []
Zmienna środowiskowa
Nazwa
Opis
Wartość
nazwa
Nazwa zmiennej środowiskowej.
ciąg (wymagany)
wartość
Wartość zmiennej środowiskowej.
ciąg (wymagany)
GitRepoVolume
Nazwa
Opis
Wartość
katalog
Nazwa katalogu docelowego. Nie może zawierać ani rozpoczynać się od ".". Jeśli element "." zostanie dostarczony, katalog woluminu będzie repozytorium git. W przeciwnym razie, jeśli zostanie określony, wolumin będzie zawierać repozytorium git w podkatalogu o podanej nazwie.
struna
repozytorium
Adres URL repozytorium
ciąg (wymagany)
rewizja
Zatwierdź skrót dla określonej poprawki.
struna
ImageRegistryCredential
Nazwa
Opis
Wartość
hasło
Hasło dla rejestru prywatnego.
struna
serwer
Serwer rejestru obrazów platformy Docker bez protokołu, takiego jak "http" i "https".
ciąg (wymagany)
nazwa użytkownika
Nazwa użytkownika rejestru prywatnego.
ciąg (wymagany)
Adresy IP
Nazwa
Opis
Wartość
Ip
Adres IP uwidoczniony w publicznym Internecie.
struna
Porty
Lista portów uwidocznionych w grupie kontenerów.
port [] (wymagane)
typ
Określa, czy adres IP jest uwidoczniony w publicznym Internecie.
"Publiczny" (wymagany)
Microsoft.ContainerInstance/containerGroups
Nazwa
Opis
Wartość
lokalizacja
Lokalizacja zasobu.
ciąg (wymagany)
nazwa
Nazwa zasobu
ciąg (wymagany)
Właściwości
ContainerGroupProperties (wymagane)
Tagi
Tagi zasobów
Słownik nazw tagów i wartości.
typ
Typ zasobu
"Microsoft.ContainerInstance/containerGroups@2017-12-01-preview"
Port
Nazwa
Opis
Wartość
port
Numer portu.
int (wymagane)
protokół
Protokół skojarzony z portem.
"TCP" "UDP"
ZasobyLimits
Nazwa
Opis
Wartość
procesor
Limit procesora CPU dla tego wystąpienia kontenera.
Int
memoryInGB
Limit pamięci w GB tego wystąpienia kontenera.
Int
ResourceRequests
Nazwa
Opis
Wartość
procesor
Żądanie procesora CPU tego wystąpienia kontenera.
int (wymagane)
memoryInGB
Żądanie pamięci w GB tego wystąpienia kontenera.
int (wymagane)
Wymagania dotyczące zasobów
Nazwa
Opis
Wartość
Limity
Limity zasobów tego wystąpienia kontenera.
ResourceLimits
Żądania
Zasób żąda tego wystąpienia kontenera.
ResourceRequests (wymagane)
SecretVolume
Głośność
Nazwa
Opis
Wartość
azureFile
Wolumin usługi Azure File.
AzureFileVolume
emptyDir
Pusty wolumin katalogu.
jakikolwiek
gitRepo
Wolumin repozytorium git.
GitRepoVolume
nazwa
Nazwa woluminu.
ciąg (wymagany)
tajny
Wolumin tajny.
SecretVolume
WoluminMount
Nazwa
Opis
Wartość
mountPath
Ścieżka w kontenerze, w którym należy zamontować wolumin. Nie może zawierać dwukropka (:).
ciąg (wymagany)
nazwa
Nazwa instalacji woluminu.
ciąg (wymagany)
readOnly
Flaga wskazująca, czy instalacja woluminu jest tylko do odczytu.
Bool