In dit artikel worden de syntaxis en eigenschappen besproken voor het YAML-bestand dat wordt ondersteund door Azure Container Instances om een containergroep te configureren. Gebruik een YAML-bestand om de groepsconfiguratie in te voeren in de opdracht az container create in de Azure CLI.
Een YAML-bestand is een handige manier om een containergroep te configureren voor reproduceerbare implementaties. Het is een beknopt alternatief voor het gebruik van een Resource Manager sjabloon of de Azure Container Instances SDK's om een containergroep te maken of bij te werken.
Notitie
Deze verwijzing is van toepassing op YAML-bestanden voor Azure Container Instances REST API-versie 2021-10-01.
Schema
Het schema voor het YAML-bestand volgt, inclusief opmerkingen om belangrijke eigenschappen te markeren. Zie de sectie Eigenschapswaarden voor een beschrijving van de eigenschappen in dit schema.
name: string # Name of the container group
apiVersion: '2021-10-01'
location: string
tags: {}
identity:
type: string
userAssignedIdentities: {}
properties: # Properties of container group
containers: # Array of container instances in the group
- name: string # Name of an instance
properties: # Properties of an instance
image: string # Container image used to create the instance
command:
- string
ports: # External-facing ports exposed on the instance, must also be set in group ipAddress property
- protocol: string
port: integer
environmentVariables:
- name: string
value: string
secureValue: string
resources: # Resource requirements of the instance
requests:
memoryInGB: number
cpu: number
gpu:
count: integer
sku: string
limits:
memoryInGB: number
cpu: number
gpu:
count: integer
sku: string
volumeMounts: # Array of volume mounts for the instance
- name: string
mountPath: string
readOnly: boolean
livenessProbe:
exec:
command:
- string
httpGet:
httpHeaders:
- name: string
value: string
path: string
port: integer
scheme: string
initialDelaySeconds: integer
periodSeconds: integer
failureThreshold: integer
successThreshold: integer
timeoutSeconds: integer
readinessProbe:
exec:
command:
- string
httpGet:
httpHeaders:
- name: string
value: string
path: string
port: integer
scheme: string
initialDelaySeconds: integer
periodSeconds: integer
failureThreshold: integer
successThreshold: integer
timeoutSeconds: integer
imageRegistryCredentials: # Credentials to pull a private image
- server: string
username: string
password: string
identity: string
identityUrl: string
restartPolicy: string
ipAddress: # IP address configuration of container group
ports:
- protocol: string
port: integer
type: string
ip: string
dnsNameLabel: string
dnsNameLabelReusePolicy: string
osType: string
volumes: # Array of volumes available to the instances
- name: string
azureFile:
shareName: string
readOnly: boolean
storageAccountName: string
storageAccountKey: string
emptyDir: {}
secret: {}
gitRepo:
directory: string
repository: string
revision: string
diagnostics:
logAnalytics:
workspaceId: string
workspaceKey: string
workspaceResourceId: string
logType: string
metadata: {}
subnetIds: # Subnet to deploy the container group into
- id: string
name: string
dnsConfig: # DNS configuration for container group
nameServers:
- string
searchDomains: string
options: string
sku: string # SKU for the container group
encryptionProperties:
vaultBaseUrl: string
keyName: string
keyVersion: string
initContainers: # Array of init containers in the group
- name: string
properties:
image: string
command:
- string
environmentVariables:
- name: string
value: string
secureValue: string
volumeMounts:
- name: string
mountPath: string
readOnly: boolean
Eigenschapswaarden
In de volgende tabellen worden de waarden beschreven die u in het schema moet instellen.
Het type identiteit dat wordt gebruikt voor de containergroep. Het type 'SystemAssigned, UserAssigned' omvat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de containergroep verwijderd. - SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None
userAssignedIdentities
object
No
De lijst met gebruikersidentiteiten die zijn gekoppeld aan de containergroep. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn Azure Resource Manager resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
De registerreferenties van de installatiekopieën waarmee de containergroep wordt gemaakt. - ImageRegistryCredential-object
restartPolicy
Enum
No
Beleid voor alle containers binnen de containergroep opnieuw opstarten. - Always Altijd opnieuw opstarten- OnFailure Opnieuw opstarten bij fout- Never Nooit opnieuw opstarten. - Altijd, OnFailure, Nooit
Het protocol dat is gekoppeld aan de poort. - TCP of UDP
poort
geheel getal
Yes
het poortnummer.
AzureFileVolume-object
Naam
Type
Vereist
Waarde
Sharenaam
tekenreeks
Ja
De naam van de Azure-bestandsshare die moet worden gekoppeld als een volume.
Readonly
booleaans
No
De vlag die aangeeft of de gedeelde Azure File die als volume is gekoppeld, alleen-lezen is.
storageAccountName
tekenreeks
Ja
De naam van het opslagaccount dat de Azure-bestandsshare bevat.
storageAccountKey
tekenreeks
No
De toegangssleutel voor het opslagaccount die wordt gebruikt voor toegang tot de Azure-bestandsshare.
GitRepoVolume-object
Naam
Type
Vereist
Waarde
map
tekenreeks
No
Naam van doelmap. Mag niet bevatten of beginnen met '..'. Als '.' wordt opgegeven, wordt de volumemap de Git-opslagplaats. Anders bevat het volume, indien opgegeven, de Git-opslagplaats in de submap met de opgegeven naam.
repository
tekenreeks
Ja
URL van opslagplaats
revision
tekenreeks
No
Hash doorvoeren voor de opgegeven revisie.
LogAnalytics-object
Naam
Type
Vereist
Waarde
workspaceId
tekenreeks
Ja
De werkruimte-id voor Log Analytics
workspaceKey
tekenreeks
Ja
De werkruimtesleutel voor Log Analytics
workspaceResourceId
tekenreeks
No
De resource-id van de werkruimte voor Log Analytics
logType
Enum
No
Het logboektype dat moet worden gebruikt. - ContainerInsights of ContainerInstanceLogs
metagegevens
object
No
Metagegevens voor log analytics.
InitContainerPropertiesDefinition-object
Naam
Type
Vereist
Waarde
image
tekenreeks
No
De installatiekopieën van de init-container.
command
matrix
No
De opdracht die moet worden uitgevoerd in de init-container in exec-vorm. -Tekenreeks
K80- en P100 GPU-SKU's worden op 31 augustus 2023 buiten gebruik gesteld. Dit komt doordat de onderliggende VM's die worden gebruikt buiten gebruik worden gesteld: NC-serie en NCv2-serie Hoewel V100-SKU's beschikbaar zijn, wordt aanbevolen om in plaats daarvan Azure Kubernetes Service te gebruiken. GPU-resources worden niet volledig ondersteund en mogen niet worden gebruikt voor productieworkloads. Gebruik de volgende resources om vandaag nog naar AKS te migreren: Migreren naar AKS.