Container Apps - Update

Uppdatera egenskaper för en containerapp
Korrigerar en containerapp med JSON Merge Patch

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}?api-version=2022-03-01

URI-parametrar

Name In Required Type Description
containerAppName
path True
  • string

Namnet på containerappen.

resourceGroupName
path True
  • string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True
  • string

ID för målprenumerationen.

api-version
query True
  • string

DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name Required Type Description
location True
  • string

Den geo-plats där resursen finns

identity

hanterade identiteter för containerappen för att interagera med andra Azure-tjänster utan att ha några hemligheter eller autentiseringsuppgifter i koden.

properties.configuration

Konfigurationsegenskaper för containerappar som inte har en version.

properties.managedEnvironmentId
  • string

Resurs-ID för containerappens miljö.

properties.template

Programdefinition med version av containerappen.

tags
  • object

Resurstaggar.

Svar

Name Type Description
202 Accepted

Korrigeringsåtgärd pågår.

Other Status Codes

Vanligt felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Patch Container App

Sample Request

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0?api-version=2022-03-01

{
  "location": "East US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "configuration": {
      "ingress": {
        "external": true,
        "targetPort": 3000,
        "customDomains": [
          {
            "name": "www.my-name.com",
            "bindingType": "SniEnabled",
            "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"
          },
          {
            "name": "www.my-other-name.com",
            "bindingType": "SniEnabled",
            "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"
          }
        ],
        "traffic": [
          {
            "weight": 100,
            "revisionName": "testcontainerApp0-ab1234",
            "label": "production"
          }
        ]
      },
      "dapr": {
        "enabled": true,
        "appPort": 3000,
        "appProtocol": "http"
      }
    },
    "template": {
      "containers": [
        {
          "image": "repo/testcontainerApp0:v1",
          "name": "testcontainerApp0",
          "probes": [
            {
              "type": "Liveness",
              "httpGet": {
                "path": "/health",
                "port": 8080,
                "httpHeaders": [
                  {
                    "name": "Custom-Header",
                    "value": "Awesome"
                  }
                ]
              },
              "initialDelaySeconds": 3,
              "periodSeconds": 3
            }
          ]
        }
      ],
      "scale": {
        "minReplicas": 1,
        "maxReplicas": 5,
        "rules": [
          {
            "name": "httpscalingrule",
            "custom": {
              "type": "http",
              "metadata": {
                "concurrentRequests": "50"
              }
            }
          }
        ]
      }
    }
  }
}

Sample Response

azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/containerappOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-03-01

Definitioner

ActiveRevisionsMode

ActiveRevisionsMode styr hur aktiva revisioner hanteras för containerappen: Flera: flera revisioner kan vara aktiva. Enskild: Endast en revision kan vara aktiv i taget. Revisionsvikter kan inte användas i det här läget. Om inget värde anges är detta standardvärdet.

appProtocol

Talar om för Dapr vilket protokoll programmet använder. Giltiga alternativ är http och grpc. Standardvärdet är http

bindingType

Custom Domain bindningstyp.

Configuration

Konfigurationsegenskaper för icke-versionshanterad containerapp som definierar de föränderliga inställningarna för en containerapp

Container

Containerappens containerdefinition.

ContainerApp

Containerapp.

ContainerAppProbe

Avsökningen beskriver en hälsokontroll som ska utföras mot en container för att avgöra om den är aktiv eller redo att ta emot trafik.

ContainerAppProvisioningState

Etableringstillstånd för containerappen.

ContainerResources

Resurskrav för containerappcontainer.

createdByType

Den typ av identitet som skapade resursen.

CustomDomain

Custom Domain av en containerapp

CustomScaleRule

Anpassad skalningsregel för containerappcontainer.

Dapr

Dapr-konfiguration för containerapp.

DefaultErrorResponse

App Service felsvar.

Details

Information eller felet

EnvironmentVar

Miljövariabel för containerappen.

Error

Felmodell.

HttpGet

HTTPGet anger http-begäran som ska utföras.

HttpHeaders

Anpassade rubriker som ska anges i begäran. HTTP tillåter upprepade rubriker.

HttpScaleRule

Anpassad skalningsregel för containerappcontainer.

Ingress

Ingresskonfiguration för containerapp.

IngressTransportMethod

Ingående transportprotokoll

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både systemtilldelade och användartilldelade typer tillåts).

QueueScaleRule

Azure Queue-baserad skalningsregel för containerappcontainer.

RegistryCredentials

Privat register för containerapp

Scale

Skalningskonfigurationer för containerappen.

ScaleRule

Skalningsregel för containerappcontainer.

ScaleRuleAuth

Autentiseringshemligheter för skalningsregel för containerappar

Scheme

Schema som ska användas för att ansluta till värden. Standardvärdet är HTTP.

Secret

Hemlig definition.

StorageType

Lagringstyp för volymen. Om inget anges använder du EmptyDir.

systemData

Metadata som rör skapande och senaste ändring av resursen.

TcpSocket

TCPSocket anger en åtgärd som involverar en TCP-port. TCP-hookar stöds inte ännu.

Template

Programdefinition med version av containerapp. Definierar önskat tillstånd för en oföränderlig revision. Ändringar i det här avsnittet resulterar i att en ny revision skapas

TrafficWeight

Trafikviktning tilldelad till en revision

Type

Typ av avsökning.

UserAssignedIdentity

Egenskaper för användartilldelad identitet

Volume

Volymdefinitioner för containerappen.

VolumeMount

Volymmontering för containerappen.

ActiveRevisionsMode

ActiveRevisionsMode styr hur aktiva revisioner hanteras för containerappen: Flera: flera revisioner kan vara aktiva. Enskild: Endast en revision kan vara aktiv i taget. Revisionsvikter kan inte användas i det här läget. Om inget värde anges är detta standardvärdet.

Name Type Description
Multiple
  • string
Single
  • string

appProtocol

Talar om för Dapr vilket protokoll programmet använder. Giltiga alternativ är http och grpc. Standardvärdet är http

Name Type Description
grpc
  • string
http
  • string

bindingType

Custom Domain bindningstyp.

Name Type Description
Disabled
  • string
SniEnabled
  • string

Configuration

Konfigurationsegenskaper för icke-versionshanterad containerapp som definierar de föränderliga inställningarna för en containerapp

Name Type Description
activeRevisionsMode

ActiveRevisionsMode styr hur aktiva revisioner hanteras för containerappen: Flera: flera revisioner kan vara aktiva. Enskild: Endast en revision kan vara aktiv i taget. Revisionsvikter kan inte användas i det här läget. Om inget värde anges är detta standardvärdet.

dapr

Dapr-konfiguration för containerappen.

ingress

Ingresskonfigurationer.

registries

Samling autentiseringsuppgifter för privata containerregister för containrar som används av containerappen

secrets

Samling hemligheter som används av en containerapp

Container

Containerappens containerdefinition.

Name Type Description
args
  • string[]

Kommandoargument för containerstart.

command
  • string[]

Startkommando för container.

env

Miljövariabler för containrar.

image
  • string

Containeravbildningstagg.

name
  • string

Anpassat containernamn.

probes

Lista över avsökningar för containern.

resources

Krav för containerresurser.

volumeMounts

Containervolymmonteringar.

ContainerApp

Containerapp.

Name Type Description
id
  • string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

hanterade identiteter för containerappen för att interagera med andra Azure-tjänster utan att ha några hemligheter eller autentiseringsuppgifter i koden.

location
  • string

Den geo-plats där resursen finns

name
  • string

Namnet på resursen

properties.configuration

Konfigurationsegenskaper för icke-versionshanterad containerapp.

properties.customDomainVerificationId
  • string

ID som används för att verifiera domännamnsägarskap

properties.latestRevisionFqdn
  • string

Fullständigt kvalificerat domännamn för den senaste versionen av containerappen.

properties.latestRevisionName
  • string

Namnet på den senaste versionen av containerappen.

properties.managedEnvironmentId
  • string

Resurs-ID för containerappens miljö.

properties.outboundIPAddresses
  • string[]

Utgående IP-adresser för containerappen.

properties.provisioningState

Etableringstillstånd för containerappen.

properties.template

Programdefinition med version av containerapp.

systemData

Azure Resource Manager metadata som innehåller createdBy och modifiedBy-information.

tags
  • object

Resurstaggar.

type
  • string

Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ContainerAppProbe

Avsökningen beskriver en hälsokontroll som ska utföras mot en container för att avgöra om den är aktiv eller redo att ta emot trafik.

Name Type Description
failureThreshold
  • integer

Minsta antal på varandra följande fel för avsökningen som ska betraktas som misslyckade efter att ha lyckats. Standardvärdet är 3. Minimivärdet är 1. Maxvärdet är 10.

httpGet

HTTPGet anger http-begäran som ska utföras.

initialDelaySeconds
  • integer

Antal sekunder efter att containern har startats innan liveavsökningar initieras. Minimivärdet är 1. Maxvärdet är 60.

periodSeconds
  • integer

Hur ofta (i sekunder) avsökningen ska utföras. Standardvärdet är 10 sekunder. Minimivärdet är 1. Maxvärdet är 240.

successThreshold
  • integer

Minsta antal lyckade resultat i följd för att avsökningen ska anses vara lyckad efter att ha misslyckats. Standardvärdet är 1. Måste vara 1 för liveness och start. Minimivärdet är 1. Maxvärdet är 10.

tcpSocket

TCPSocket anger en åtgärd som involverar en TCP-port. TCP-hookar stöds inte ännu.

terminationGracePeriodSeconds
  • integer

Valfri varaktighet i sekunder podden måste avslutas korrekt vid avsökningsfel. Respitperioden är varaktigheten i sekunder efter att processerna som körs i podden har skickats en avslutningssignal och den tid då processerna med två skäl stoppas med en kill-signal. Ange det här värdet längre än den förväntade rensningstiden för processen. Om det här värdet är noll används poddens terminationGracePeriodSeconds. Annars åsidosätter det här värdet värdet som tillhandahålls av poddspecifikationen. Värdet måste vara ett heltal som inte är negativt. Värdet noll anger stopp direkt via kill-signalen (ingen möjlighet att stänga av). Det här är ett alfafält och kräver aktivering av funktionsporten ProbeTerminationGracePeriod. Maxvärdet är 3 600 sekunder (1 timme)

timeoutSeconds
  • integer

Antal sekunder som avsökningen överskrider tidsgränsen. Standardvärdet är 1 sekund. Minimivärdet är 1. Maxvärdet är 240.

type

Typ av avsökning.

ContainerAppProvisioningState

Etableringstillstånd för containerappen.

Name Type Description
Canceled
  • string
Deleting
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string

ContainerResources

Resurskrav för containerappcontainer.

Name Type Description
cpu
  • number

Nödvändig PROCESSOR i kärnor, t.ex. 0,5

ephemeralStorage
  • string

Tillfällig lagring, t.ex. "1Gi"

memory
  • string

Nödvändigt minne, t.ex. "250 Mb"

createdByType

Den typ av identitet som skapade resursen.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

CustomDomain

Custom Domain av en containerapp

Name Type Description
bindingType

Custom Domain bindningstyp.

certificateId
  • string

Resurs-ID för certifikatet som ska bindas till det här värdnamnet. Måste finnas i den hanterade miljön.

name
  • string

Värdnamn.

CustomScaleRule

Anpassad skalningsregel för containerappcontainer.

Name Type Description
auth

Autentiseringshemligheter för den anpassade skalningsregeln.

metadata
  • object

Metadataegenskaper för att beskriva en anpassad skalningsregel.

type
  • string

Typ av anpassad skalningsregel t.ex. azure-servicebus, redis osv.

Dapr

Dapr-konfiguration för containerapp.

Name Type Description
appId
  • string

Dapr-programidentifierare

appPort
  • integer

Talar om för Dapr vilken port programmet lyssnar på

appProtocol

Talar om för Dapr vilket protokoll programmet använder. Giltiga alternativ är http och grpc. Standardvärdet är http

enabled
  • boolean

Booleskt värde som anger om Dapr-sidobilen är aktiverad

DefaultErrorResponse

App Service felsvar.

Name Type Description
error

Felmodell.

Details

Information eller felet

Name Type Description
code
  • string

Standardiserad sträng för att programmässigt identifiera felet.

message
  • string

Detaljerad felbeskrivning och felsökningsinformation.

target
  • string

Detaljerad felbeskrivning och felsökningsinformation.

EnvironmentVar

Miljövariabel för containerappen.

Name Type Description
name
  • string

Miljövariabelnamn.

secretRef
  • string

Namnet på containerappens hemlighet som miljövariabelvärdet ska hämtas från.

value
  • string

Variabelvärde för icke-hemlig miljö.

Error

Felmodell.

Name Type Description
code
  • string

Standardiserad sträng för att programmässigt identifiera felet.

details

Information eller felet

innererror
  • string

Mer information om felsökningsfel.

message
  • string

Detaljerad felbeskrivning och felsökningsinformation.

target
  • string

Detaljerad felbeskrivning och felsökningsinformation.

HttpGet

HTTPGet anger http-begäran som ska utföras.

Name Type Description
host
  • string

Värdnamn att ansluta till, standardvärdet är podd-IP-adressen. Du vill förmodligen ange "Värd" i httpHeaders i stället.

httpHeaders

Anpassade rubriker som ska anges i begäran. HTTP tillåter upprepade rubriker.

path
  • string

Sökväg till åtkomst på HTTP-servern.

port
  • integer

Namn eller nummer på porten som ska kommas åt i containern. Talet måste vara mellan 1 och 65535. Namnet måste vara ett IANA_SVC_NAME.

scheme

Schema som ska användas för att ansluta till värden. Standardvärdet är HTTP.

HttpHeaders

Anpassade rubriker som ska anges i begäran. HTTP tillåter upprepade rubriker.

Name Type Description
name
  • string

Namn på rubrikfält

value
  • string

Sidhuvudfältsvärdet

HttpScaleRule

Anpassad skalningsregel för containerappcontainer.

Name Type Description
auth

Autentiseringshemligheter för den anpassade skalningsregeln.

metadata
  • object

Metadataegenskaper för att beskriva http-skalningsregel.

Ingress

Ingresskonfiguration för containerapp.

Name Type Default Value Description
allowInsecure
  • boolean

Bool som anger om HTTP-anslutningar till tillåts. Om värdet är inställt på falska HTTP-anslutningar omdirigeras automatiskt till HTTPS-anslutningar

customDomains

anpassade domänbindningar för Container Apps värdnamn.

external
  • boolean
False

Bool som anger om appen exponerar en extern http-slutpunkt

fqdn
  • string

Värdnamn.

targetPort
  • integer

Målport i containrar för trafik från ingress

traffic

Trafikvikter för appens revisioner

transport

Ingående transportprotokoll

IngressTransportMethod

Ingående transportprotokoll

Name Type Description
auto
  • string
http
  • string
http2
  • string

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name Type Description
principalId
  • string

Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

tenantId
  • string

Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

type

Typ av hanterad tjänstidentitet (där både systemtilldelade och användartilldelade typer tillåts).

userAssignedIdentities

User-Assigned identiteter
Den uppsättning användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både systemtilldelade och användartilldelade typer tillåts).

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

QueueScaleRule

Azure Queue-baserad skalningsregel för containerappcontainer.

Name Type Description
auth

Autentiseringshemligheter för köskalningsregeln.

queueLength
  • integer

Kölängd.

queueName
  • string

Könamn.

RegistryCredentials

Privat register för containerapp

Name Type Description
identity
  • string

En hanterad identitet som ska användas för att autentisera med Azure Container Registry. För användartilldelade identiteter använder du det fullständiga användartilldelade identitetsresurs-ID:t. För systemtilldelade identiteter använder du "system"

passwordSecretRef
  • string

Namnet på hemligheten som innehåller lösenordet för registerinloggning

server
  • string

Container Registry Server

username
  • string

Användarnamn för containerregister

Scale

Skalningskonfigurationer för containerappen.

Name Type Description
maxReplicas
  • integer

Valfritt. Maximalt antal containerrepliker. Standardvärdet är 10 om det inte anges.

minReplicas
  • integer

Valfritt. Minsta antal containerrepliker.

rules

Skalningsregler.

ScaleRule

Skalningsregel för containerappcontainer.

Name Type Description
azureQueue

Azure Queue-baserad skalning.

custom

Anpassad skalningsregel.

http

HTTP-begärandensbaserad skalning.

name
  • string

Namn på skalningsregel

ScaleRuleAuth

Autentiseringshemligheter för skalningsregel för containerappar

Name Type Description
secretRef
  • string

Namnet på containerappens hemlighet som autentiseringsparamerna ska hämtas från.

triggerParameter
  • string

Utlösarparameter som använder hemligheten

Scheme

Schema som ska användas för att ansluta till värden. Standardvärdet är HTTP.

Name Type Description
HTTP
  • string
HTTPS
  • string

Secret

Hemlig definition.

Name Type Description
name
  • string

Hemligt namn.

value
  • string

Hemligt värde.

StorageType

Lagringstyp för volymen. Om inget anges använder du EmptyDir.

Name Type Description
AzureFile
  • string
EmptyDir
  • string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Type Description
createdAt
  • string

Tidsstämpeln för resursskapande (UTC).

createdBy
  • string

Identiteten som skapade resursen.

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt
  • string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy
  • string

Identiteten som senast ändrade resursen.

lastModifiedByType

Den typ av identitet som senast ändrade resursen.

TcpSocket

TCPSocket anger en åtgärd som involverar en TCP-port. TCP-hookar stöds inte ännu.

Name Type Description
host
  • string

Valfritt: Värdnamn att ansluta till, standardvärdet är poddens IP-adress.

port
  • integer

Nummer eller namn på porten för åtkomst till containern. Talet måste ligga inom intervallet 1 till 65535. Namnet måste vara en IANA_SVC_NAME.

Template

Programdefinition med version av containerapp. Definierar önskat tillstånd för en oföränderlig revision. Ändringar i det här avsnittet resulterar i att en ny revision skapas

Name Type Description
containers

Lista över containerdefinitioner för containerappen.

revisionSuffix
  • string

Användarvänligt suffix som läggs till i revisionsnamnet

scale

Skalningsegenskaper för containerappen.

volumes

Lista över volymdefinitioner för containerappen.

TrafficWeight

Trafikviktning tilldelad till en revision

Name Type Default Value Description
label
  • string

Associerar en trafiketikett med en revision

latestRevision
  • boolean
False

Anger att trafikvikten tillhör en senaste stabil revision

revisionName
  • string

Namn på en revision

weight
  • integer

Trafikviktning tilldelad till en revision

Type

Typ av avsökning.

Name Type Description
Liveness
  • string
Readiness
  • string
Startup
  • string

UserAssignedIdentity

Egenskaper för användartilldelad identitet

Name Type Description
clientId
  • string

Klient-ID för den tilldelade identiteten.

principalId
  • string

Huvud-ID för den tilldelade identiteten.

Volume

Volymdefinitioner för containerappen.

Name Type Description
name
  • string

Volymnamn.

storageName
  • string

Namnet på lagringsresursen. Du behöver inte ange EmptyDir.

storageType

Lagringstyp för volymen. Om inget anges använder du EmptyDir.

VolumeMount

Volymmontering för containerappen.

Name Type Description
mountPath
  • string

Sökväg i containern där volymen ska monteras. Får inte innehålla :.

volumeName
  • string

Detta måste matcha namnet på en volym.