Udostępnij za pośrednictwem

Microsoft.AppPlatform Spring/apps/deployments 2023-03-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu Spring/apps/deployments można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.AppPlatform/Spring/apps/deployments, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview' = {
  name: 'string'
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    active: bool
    deploymentSettings: {
      addonConfigs: {}
      containerProbeSettings: {
        disableProbe: bool
      }
      environmentVariables: {}
      livenessProbe: {
        disableProbe: bool
        failureThreshold: int
        initialDelaySeconds: int
        periodSeconds: int
        probeAction: {
          type: 'string'
          // For remaining properties, see ProbeAction objects
        }
        successThreshold: int
        timeoutSeconds: int
      }
      readinessProbe: {
        disableProbe: bool
        failureThreshold: int
        initialDelaySeconds: int
        periodSeconds: int
        probeAction: {
          type: 'string'
          // For remaining properties, see ProbeAction objects
        }
        successThreshold: int
        timeoutSeconds: int
      }
      resourceRequests: {
        cpu: 'string'
        memory: 'string'
      }
      scale: {
        maxReplicas: int
        minReplicas: int
        rules: [
          {
            azureQueue: {
              auth: [
                {
                  secretRef: 'string'
                  triggerParameter: 'string'
                }
              ]
              queueLength: int
              queueName: 'string'
            }
            custom: {
              auth: [
                {
                  secretRef: 'string'
                  triggerParameter: 'string'
                }
              ]
              metadata: {}
              type: 'string'
            }
            http: {
              auth: [
                {
                  secretRef: 'string'
                  triggerParameter: 'string'
                }
              ]
              metadata: {}
            }
            name: 'string'
            tcp: {
              auth: [
                {
                  secretRef: 'string'
                  triggerParameter: 'string'
                }
              ]
              metadata: {}
            }
          }
        ]
      }
      startupProbe: {
        disableProbe: bool
        failureThreshold: int
        initialDelaySeconds: int
        periodSeconds: int
        probeAction: {
          type: 'string'
          // For remaining properties, see ProbeAction objects
        }
        successThreshold: int
        timeoutSeconds: int
      }
      terminationGracePeriodSeconds: int
    }
    source: {
      version: 'string'
      type: 'string'
      // For remaining properties, see UserSourceInfo objects
    }
  }
}

Obiekty ProbeAction

Ustaw właściwość type , aby określić typ obiektu.

W przypadku narzędzia ExecAction użyj:

  type: 'ExecAction'
  command: [
    'string'
  ]

W przypadku funkcji HTTPGetAction użyj:

  type: 'HTTPGetAction'
  path: 'string'
  scheme: 'string'

W przypadku protokołu TCPSocketAction użyj:

  type: 'TCPSocketAction'

Obiekty UserSourceInfo

Ustaw właściwość type , aby określić typ obiektu.

W przypadku polecenia BuildResult użyj:

  type: 'BuildResult'
  buildResultId: 'string'

W przypadku kontenera użyj:

  type: 'Container'
  customContainer: {
    args: [
      'string'
    ]
    command: [
      'string'
    ]
    containerImage: 'string'
    imageRegistryCredential: {
      password: 'string'
      username: 'string'
    }
    languageFramework: 'string'
    server: 'string'
  }

W przypadku pliku Jar użyj:

  type: 'Jar'
  jvmOptions: 'string'
  relativePath: 'string'
  runtimeVersion: 'string'

W przypadku narzędzia NetCoreZip użyj:

  type: 'NetCoreZip'
  netCoreMainEntryPath: 'string'
  relativePath: 'string'
  runtimeVersion: 'string'

W obszarze Źródło użyj:

  type: 'Source'
  artifactSelector: 'string'
  relativePath: 'string'
  runtimeVersion: 'string'

Wartości właściwości

Spring/apps/deployments

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
sku Jednostka SKU zasobu wdrożenia Numer jednostki magazynowej
Nadrzędny W pliku Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Symboliczna nazwa zasobu typu: aplikacje
properties Właściwości zasobu Wdrożenia DeploymentResourceProperties

DeploymentResourceProperties

Nazwa Opis Wartość
aktywne Wskazuje, czy wdrożenie jest aktywne bool
deploymentSettings Ustawienia wdrożenia wdrożenia DeploymentSettings
source Przekazane informacje o źródle wdrożenia. UserSourceInfo

DeploymentSettings

Nazwa Opis Wartość
addonConfigs Kolekcja dodatków object
containerProbeSettings Ustawienia sondy kondycji i gotowości kontenera ContainerProbeSettings
environmentVariables Kolekcja zmiennych środowiskowych object
livenessProbe Okresowa sonda aktualności wystąpienia aplikacji. Wystąpienie aplikacji zostanie ponownie uruchomione, jeśli sonda zakończy się niepowodzeniem. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
gotowośćProbe Okresowa sonda gotowości usługi App Instance Service. Wystąpienie aplikacji zostanie usunięte z punktów końcowych usługi, jeśli sonda zakończy się niepowodzeniem. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
resourceRequests Żądana ilość zasobów dla wymaganego procesora CPU i pamięci. Zaleca się, aby użycie tego pola do reprezentowania wymaganego procesora CPU i pamięci oznaczało, że stary procesor i pamięćInGB zostaną wycofane później. ResourceRequests
scale Skalowanie właściwości dla wystąpienia aplikacji Azure Spring Apps. Skalowanie
startupProbe StartupProbe wskazuje, że wystąpienie aplikacji zostało pomyślnie zainicjowane. Jeśli zostanie określony, żadne inne sondy nie zostaną wykonane do momentu pomyślnego zakończenia. Jeśli ta sonda zakończy się niepowodzeniem, zasobnik zostanie uruchomiony ponownie, tak jak w przypadku niepowodzenia livenessProbe. Może to służyć do zapewnienia różnych parametrów sondy na początku cyklu życia wystąpienia aplikacji, gdy ładowanie danych lub ciepło pamięci podręcznej może zająć dużo czasu niż podczas operacji na stałym stanie. Nie można tego zaktualizować. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
terminationGracePeriodSeconds Opcjonalny czas trwania w sekundach, który wystąpienie aplikacji musi zostać zakończone w sposób ciągły. Może zostać zmniejszony w żądaniu usuwania. Wartość musi być nie ujemną liczbą całkowitą. Wartość zero wskazuje, że zatrzymaj się natychmiast za pośrednictwem sygnału zabijania (brak możliwości zamknięcia). Jeśli ta wartość jest zerowa, zostanie użyty domyślny okres prolongaty. Okres prolongaty to czas trwania w sekundach po wysłaniu sygnału zakończenia procesów uruchomionych w wystąpieniu aplikacji i czasie, kiedy procesy są wymuszone zatrzymane za pomocą sygnału zabijania. Ustaw tę wartość dłużej niż oczekiwany czas oczyszczania procesu. Wartość domyślna to 90 sekund. int

ContainerProbeSettings

Nazwa Opis Wartość
disableProbe Wskazuje, czy wyłączyć sondę utrzymania i gotowości bool

Sonda

Nazwa Opis Wartość
disableProbe Określ, czy sonda jest wyłączona. bool (wymagane)
failureThreshold Minimalna liczba kolejnych niepowodzeń dla sondy, które mają zostać uznane za zakończone niepowodzeniem po pomyślnym zakończeniu. Wartość minimalna to 1. int
initialDelaySeconds Liczba sekund po uruchomieniu wystąpienia aplikacji przed zainicjowaniem sond. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes int
periodSeconds Jak często (w sekundach) wykonać sondę. Wartość minimalna to 1. int
probeAction Akcja sondy. SondaAction
successThreshold Minimalna liczba kolejnych sukcesów dla sondy, która ma zostać uznana za pomyślną po niepodaniu. Musi być 1 dla utrzymania i uruchamiania. Wartość minimalna to 1. int
timeoutSeconds Liczba sekund, po których sonda upłynął limit czasu. Wartość minimalna to 1. int

SondaAction

Nazwa Opis Wartość
typ Ustawianie typu obiektu ExecAction
HTTPGetAction
TCPSocketAction (wymagane)

ExecAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "ExecAction" (wymagane)
command Polecenie jest wierszem polecenia do wykonania wewnątrz kontenera, katalog roboczy dla polecenia jest główny ('/') w systemie plików kontenera. Polecenie nie jest uruchamiane wewnątrz powłoki, więc tradycyjne instrukcje powłoki (','itp.) nie będą działać. Aby użyć powłoki, należy jawnie wywołać do tej powłoki. Stan wyjścia 0 jest traktowany jako żywy/zdrowy i niezerowy jest w złej kondycji. ciąg[]

HttpGetAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "HTTPGetAction" (wymagane)
path Ścieżka dostępu do serwera HTTP. ciąg
schemat Schemat używany do nawiązywania połączenia z hostem. Wartość domyślna to HTTP.

Możliwe wartości wyliczenia:
- "HTTP" oznacza, że używany schemat będzie http://
- "HTTPS" oznacza, że używany schemat będzie https://		 "HTTP"
"HTTPS"

TCPSocketAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "TCPSocketAction" (wymagane)

ResourceRequests

Nazwa Opis Wartość
Procesora Wymagany procesor CPU. 1 rdzeń może być reprezentowany przez 1 lub 1000m. Powinno to być 500 m lub 1 dla warstwy Podstawowa, a {500m, 1, 2, 3, 4} dla warstwy Standardowa. ciąg
pamięć Wymagana pamięć. 1 GB może być reprezentowane przez 1Gi lub 1024Mi. Powinna to być wartość {512Mi, 1Gi, 2Gi} dla warstwy Podstawowa i {512Mi, 1Gi, 2Gi, ..., 8Gi} dla warstwy Standardowa. ciąg

Skalowanie

Nazwa Opis Wartość
maxReplicas Opcjonalny. Maksymalna liczba replik kontenerów. Wartość domyślna to 10, jeśli nie zostanie ustawiona. int
minReplicas Opcjonalny. Minimalna liczba replik kontenerów. int
rules Reguły skalowania. ScaleRule[]

ScaleRule

Nazwa Opis Wartość
azureQueue Skalowanie oparte na kolejce platformy Azure. QueueScaleRule
niestandardowe Niestandardowa reguła skalowania. CustomScaleRule
http Skalowanie na podstawie żądań HTTP. HttpScaleRule
name Nazwa reguły skalowania ciąg
Tcp Skalowanie oparte na żądaniach TCP. TcpScaleRule

QueueScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania kolejek. ScaleRuleAuth[]
queueLength Długość kolejki. int
Queuename Nazwa kolejki. ciąg

ScaleRuleAuth

Nazwa Opis Wartość
secretRef Nazwa wpisu tajnego usługi Azure Spring Apps App Instance, z którego chcesz ściągnąć parametry uwierzytelniania. ciąg
triggerParameter Parametr wyzwalacza, który używa wpisu tajnego ciąg

CustomScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania niestandardowego. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące niestandardową regułę skalowania. object
typ Typ reguły skalowania niestandardowego
np. azure-servicebus, redis itp.
 ciąg

HttpScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania niestandardowego. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące regułę skalowania http. object

TcpScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania tcp. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące regułę skalowania tcp. object

UserSourceInfo

Nazwa Opis Wartość
Wersja Wersja źródła ciąg
typ Ustawianie typu obiektu BuildResult
Kontener
Jar
NetCoreZip
Źródło (wymagane)

BuildResultUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "BuildResult" (wymagane)
buildResultId Identyfikator zasobu istniejącego pomyślnego wyniku kompilacji w ramach tego samego wystąpienia spring. ciąg

CustomContainerUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Kontener" (wymagany)
customContainer Niestandardowy ładunek kontenera CustomContainer

CustomContainer

Nazwa Opis Wartość
args Argumenty do punktu wejścia. CmD obrazu platformy Docker jest używany, jeśli nie jest to podane. ciąg[]
command Tablica punktów wejścia. Nie jest wykonywane w powłoce. Jeśli nie podano tego elementu, używany jest punkt WEJŚCIA obrazu platformy Docker. ciąg[]
containerImage Obraz kontenera niestandardowego kontenera. Powinno to mieć postać {repository}:{tag} bez nazwy serwera rejestru ciąg
imageRegistryCredential Poświadczenia rejestru obrazów ImageRegistryCredential
languageFramework Struktura języka przekazanego obrazu kontenera ciąg
serwer Nazwa rejestru zawierającego obraz kontenera ciąg

ImageRegistryCredential

Nazwa Opis Wartość
hasło Hasło poświadczeń rejestru obrazów ciąg
nazwa użytkownika Nazwa użytkownika poświadczeń rejestru obrazów ciąg

JarUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Jar" (wymagany)
jvmOptions Parametr JVM ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku Jar ciąg

NetCoreZipUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "NetCoreZip" (wymagany)
netCoreMainEntryPath Ścieżka do pliku wykonywalnego .NET względem katalogu głównego zip ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku .Net ciąg

SourceUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Źródło" (wymagane)
artifactSelector Selektor artefaktu, który ma być używany do wdrożenia w projektach z wieloma modułami. Powinno to być
ścieżka względna do docelowego modułu/projektu.		 ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku źródłowego ciąg

SKU

Nazwa Opis Wartość
capacity Bieżąca pojemność zasobu docelowego int
name Nazwa jednostki SKU ciąg
tier Warstwa jednostki SKU ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu Spring/apps/deployments można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.AppPlatform/Spring/apps/deployments, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.AppPlatform/Spring/apps/deployments",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "active": "bool",
    "deploymentSettings": {
      "addonConfigs": {},
      "containerProbeSettings": {
        "disableProbe": "bool"
      },
      "environmentVariables": {},
      "livenessProbe": {
        "disableProbe": "bool",
        "failureThreshold": "int",
        "initialDelaySeconds": "int",
        "periodSeconds": "int",
        "probeAction": {
          "type": "string"
          // For remaining properties, see ProbeAction objects
        },
        "successThreshold": "int",
        "timeoutSeconds": "int"
      },
      "readinessProbe": {
        "disableProbe": "bool",
        "failureThreshold": "int",
        "initialDelaySeconds": "int",
        "periodSeconds": "int",
        "probeAction": {
          "type": "string"
          // For remaining properties, see ProbeAction objects
        },
        "successThreshold": "int",
        "timeoutSeconds": "int"
      },
      "resourceRequests": {
        "cpu": "string",
        "memory": "string"
      },
      "scale": {
        "maxReplicas": "int",
        "minReplicas": "int",
        "rules": [
          {
            "azureQueue": {
              "auth": [
                {
                  "secretRef": "string",
                  "triggerParameter": "string"
                }
              ],
              "queueLength": "int",
              "queueName": "string"
            },
            "custom": {
              "auth": [
                {
                  "secretRef": "string",
                  "triggerParameter": "string"
                }
              ],
              "metadata": {},
              "type": "string"
            },
            "http": {
              "auth": [
                {
                  "secretRef": "string",
                  "triggerParameter": "string"
                }
              ],
              "metadata": {}
            },
            "name": "string",
            "tcp": {
              "auth": [
                {
                  "secretRef": "string",
                  "triggerParameter": "string"
                }
              ],
              "metadata": {}
            }
          }
        ]
      },
      "startupProbe": {
        "disableProbe": "bool",
        "failureThreshold": "int",
        "initialDelaySeconds": "int",
        "periodSeconds": "int",
        "probeAction": {
          "type": "string"
          // For remaining properties, see ProbeAction objects
        },
        "successThreshold": "int",
        "timeoutSeconds": "int"
      },
      "terminationGracePeriodSeconds": "int"
    },
    "source": {
      "version": "string",
      "type": "string"
      // For remaining properties, see UserSourceInfo objects
    }
  }
}

Obiekty ProbeAction

Ustaw właściwość type , aby określić typ obiektu.

W przypadku narzędzia ExecAction użyj:

  "type": "ExecAction",
  "command": [ "string" ]

W przypadku funkcji HTTPGetAction użyj:

  "type": "HTTPGetAction",
  "path": "string",
  "scheme": "string"

W przypadku protokołu TCPSocketAction użyj:

  "type": "TCPSocketAction"

Obiekty UserSourceInfo

Ustaw właściwość type , aby określić typ obiektu.

W przypadku elementu BuildResult użyj:

  "type": "BuildResult",
  "buildResultId": "string"

W przypadku kontenera użyj:

  "type": "Container",
  "customContainer": {
    "args": [ "string" ],
    "command": [ "string" ],
    "containerImage": "string",
    "imageRegistryCredential": {
      "password": "string",
      "username": "string"
    },
    "languageFramework": "string",
    "server": "string"
  }

W przypadku pliku Jar użyj polecenia:

  "type": "Jar",
  "jvmOptions": "string",
  "relativePath": "string",
  "runtimeVersion": "string"

W przypadku narzędzia NetCoreZip użyj:

  "type": "NetCoreZip",
  "netCoreMainEntryPath": "string",
  "relativePath": "string",
  "runtimeVersion": "string"

W obszarze Źródło użyj:

  "type": "Source",
  "artifactSelector": "string",
  "relativePath": "string",
  "runtimeVersion": "string"

Wartości właściwości

Spring/apps/deployments

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.AppPlatform/Spring/apps/deployments"
apiVersion Wersja interfejsu API zasobów "2023-03-01-preview"
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.		 ciąg (wymagany)
sku Jednostka SKU zasobu wdrożenia Numer jednostki magazynowej
properties Właściwości zasobu wdrożenia DeploymentResourceProperties

DeploymentResourceProperties

Nazwa Opis Wartość
aktywne Wskazuje, czy wdrożenie jest aktywne bool
deploymentSettings Ustawienia wdrażania wdrożenia DeploymentSettings
source Przekazane informacje o źródle wdrożenia. UserSourceInfo

DeploymentSettings

Nazwa Opis Wartość
addonConfigs Kolekcja dodatków object
containerProbeSettings Ustawienia sondy kondycji i gotowości kontenera ContainerProbeSettings
environmentVariables Kolekcja zmiennych środowiskowych object
livenessProbe Okresowa sonda aktualności wystąpienia aplikacji. Wystąpienie aplikacji zostanie uruchomione ponownie, jeśli sonda zakończy się niepowodzeniem. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
gotowośćProbe Okresowa sonda gotowości usługi Wystąpienia aplikacji. Wystąpienie aplikacji zostanie usunięte z punktów końcowych usługi, jeśli sonda zakończy się niepowodzeniem. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
resourceRequests Żądana ilość zasobów dla wymaganego procesora CPU i pamięci. Zaleca się, aby użycie tego pola do reprezentowania wymaganego procesora CPU i pamięci, stary procesor i pamięćInGB zostaną wycofane później. ResourceRequests
scale Właściwości skalowania dla wystąpienia aplikacji usługi Azure Spring Apps. Skalowanie
startupProbe StartupProbe wskazuje, że wystąpienie aplikacji zostało pomyślnie zainicjowane. Jeśli zostanie określony, żadne inne sondy nie zostaną wykonane do momentu pomyślnego zakończenia. Jeśli ta sonda nie powiedzie się, zasobnik zostanie uruchomiony ponownie, tak jak w przypadku niepowodzenia livenessProbe. Może to służyć do zapewnienia różnych parametrów sondy na początku cyklu życia wystąpienia aplikacji, gdy ładowanie danych lub ciepło pamięci podręcznej może zająć dużo czasu, niż podczas operacji stałego stanu. Nie można tego zaktualizować. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
terminationGracePeriodSeconds Opcjonalny czas trwania w sekundach, przez który wystąpienie aplikacji musi zostać bezpiecznie zakończone. Może zostać zmniejszona w żądaniu usuwania. Wartość musi być nieujemną liczbą całkowitą. Wartość zero wskazuje zatrzymać się natychmiast za pośrednictwem sygnału zabicia (brak możliwości zamknięcia). Jeśli ta wartość jest zerowa, zostanie użyty domyślny okres prolongaty. Okres prolongaty to czas trwania w sekundach po wysłaniu sygnału zakończenia procesów uruchomionych w wystąpieniu aplikacji i czasie, kiedy procesy są wymuszone zatrzymane za pomocą sygnału zabicia. Ustaw tę wartość dłużej niż oczekiwany czas oczyszczania dla procesu. Wartość domyślna to 90 sekund. int

ContainerProbeSettings

Nazwa Opis Wartość
disableProbe Wskazuje, czy wyłączyć sondę utrzymania i gotowości bool

Sonda

Nazwa Opis Wartość
disableProbe Określ, czy sonda jest wyłączona. bool (wymagane)
failureThreshold Minimalna liczba kolejnych niepowodzeń dla sondy, które mają zostać uznane za zakończone niepowodzeniem po pomyślnym zakończeniu. Wartość minimalna to 1. int
initialDelaySeconds Liczba sekund po uruchomieniu wystąpienia aplikacji przed zainicjowaniem sond. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes int
periodSeconds Jak często (w sekundach) wykonać sondę. Wartość minimalna to 1. int
probeAction Akcja sondy. ProbeAction
successThreshold Minimalna liczba kolejnych sukcesów dla sondy, która ma zostać uznana za pomyślną po niepodaniu. Musi być 1 dla życia i uruchamiania. Wartość minimalna to 1. int
timeoutSeconds Liczba sekund, po których upłynął limit czasu sondy. Wartość minimalna to 1. int

ProbeAction

Nazwa Opis Wartość
typ Ustawianie typu obiektu ExecAction
HttpGetAction
TCPSocketAction (wymagane)

ExecAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "ExecAction" (wymagane)
command Polecenie jest wierszem polecenia do wykonania wewnątrz kontenera, katalog roboczy dla polecenia jest główny ('/') w systemie plików kontenera. Polecenie nie jest uruchamiane wewnątrz powłoki, więc tradycyjne instrukcje powłoki (',', itp.) nie będą działać. Aby użyć powłoki, należy jawnie wywołać powłokę. Stan zakończenia 0 jest traktowany jako dynamiczny/w dobrej kondycji, a stan inny niż zero jest w złej kondycji. ciąg[]

HttpGetAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "HTTPGetAction" (wymagane)
path Ścieżka dostępu do serwera HTTP. ciąg
schemat Schemat używany do nawiązywania połączenia z hostem. Wartość domyślna to HTTP.

Możliwe wartości wyliczenia:
- "HTTP" oznacza, że używany schemat będzie http://
- "HTTPS" oznacza, że używany schemat będzie https://		 "HTTP"
"HTTPS"

TCPSocketAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "TCPSocketAction" (wymagane)

ResourceRequests

Nazwa Opis Wartość
Procesora Wymagany procesor CPU. 1 rdzeń może być reprezentowany przez 1 lub 1000 m. Powinna to być wartość 500m lub 1 dla warstwy Podstawowa, a dla warstwy Standardowa :500m, 1, 2, 3, 4}. ciąg
pamięć Wymagana pamięć. 1 GB może być reprezentowane przez 1Gi lub 1024Mi. Powinno to być {512Mi, 1Gi, 2Gi} dla warstwy Podstawowa i {512Mi, 1Gi, 2Gi, ..., 8Gi} dla warstwy Standardowa. ciąg

Skalowanie

Nazwa Opis Wartość
maxReplicas Opcjonalny. Maksymalna liczba replik kontenerów. Wartość domyślna to 10, jeśli nie jest ustawiona. int
minReplicas Opcjonalny. Minimalna liczba replik kontenerów. int
rules Reguły skalowania. ScaleRule[]

ScaleRule

Nazwa Opis Wartość
azureQueue Skalowanie na podstawie kolejki platformy Azure. QueueScaleRule
niestandardowe Reguła skalowania niestandardowego. CustomScaleRule
http Skalowanie na podstawie żądań HTTP. HttpScaleRule
name Nazwa reguły skalowania ciąg
Tcp Skalowanie na podstawie żądań TCP. TcpScaleRule

QueueScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania kolejek. ScaleRuleAuth[]
queueLength Długość kolejki. int
Queuename Nazwa kolejki. ciąg

ScaleRuleAuth

Nazwa Opis Wartość
secretRef Nazwa wpisu tajnego wystąpienia aplikacji usługi Azure Spring Apps, z którego mają być pobierane parametry uwierzytelniania. ciąg
triggerParameter Parametr wyzwalacza, który używa wpisu tajnego ciąg

CustomScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania niestandardowego. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące niestandardową regułę skalowania. object
typ Typ reguły skalowania niestandardowego
np. azure-servicebus, redis itp.
 ciąg

HttpScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania niestandardowego. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące regułę skalowania http. object

TcpScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania tcp. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące regułę skalowania tcp. object

UserSourceInfo

Nazwa Opis Wartość
Wersja Wersja źródła ciąg
typ Ustawianie typu obiektu BuildResult
Kontener
Jar
NetCoreZip
Źródło (wymagane)

BuildResultUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "BuildResult" (wymagane)
buildResultId Identyfikator zasobu istniejącego pomyślnego wyniku kompilacji w ramach tego samego wystąpienia spring. ciąg

CustomContainerUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Kontener" (wymagany)
customContainer Niestandardowy ładunek kontenera CustomContainer

CustomContainer

Nazwa Opis Wartość
args Argumenty do punktu wejścia. CmD obrazu platformy Docker jest używany, jeśli nie jest to podane. ciąg[]
command Tablica punktów wejścia. Nie jest wykonywane w powłoce. Jeśli nie podano tego elementu, używany jest punkt WEJŚCIA obrazu platformy Docker. ciąg[]
containerImage Obraz kontenera niestandardowego kontenera. Powinno to mieć postać {repository}:{tag} bez nazwy serwera rejestru ciąg
imageRegistryCredential Poświadczenia rejestru obrazów ImageRegistryCredential
languageFramework Struktura języka przekazanego obrazu kontenera ciąg
serwer Nazwa rejestru zawierającego obraz kontenera ciąg

ImageRegistryCredential

Nazwa Opis Wartość
hasło Hasło poświadczeń rejestru obrazów ciąg
nazwa użytkownika Nazwa użytkownika poświadczeń rejestru obrazów ciąg

JarUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Jar" (wymagane)
jvmOptions Parametr JVM ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku Jar ciąg

NetCoreZipUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "NetCoreZip" (wymagane)
netCoreMainEntryPath Ścieżka do pliku wykonywalnego .NET względem katalogu głównego zip ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku .Net ciąg

SourceUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Źródło" (wymagane)
artifactSelector Selektor artefaktu, który ma być używany do wdrożenia w projektach z wieloma modułami. Powinno to być
ścieżka względna do docelowego modułu/projektu.		 ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku źródłowego ciąg

SKU

Nazwa Opis Wartość
capacity Bieżąca pojemność zasobu docelowego int
name Nazwa jednostki SKU ciąg
tier Warstwa jednostki SKU ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu Spring/apps/deployments można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.AppPlatform/Spring/apps/deployments, dodaj następujący element Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      active = bool
      deploymentSettings = {
        addonConfigs = {}
        containerProbeSettings = {
          disableProbe = bool
        }
        environmentVariables = {}
        livenessProbe = {
          disableProbe = bool
          failureThreshold = int
          initialDelaySeconds = int
          periodSeconds = int
          probeAction = {
            type = "string"
            // For remaining properties, see ProbeAction objects
          }
          successThreshold = int
          timeoutSeconds = int
        }
        readinessProbe = {
          disableProbe = bool
          failureThreshold = int
          initialDelaySeconds = int
          periodSeconds = int
          probeAction = {
            type = "string"
            // For remaining properties, see ProbeAction objects
          }
          successThreshold = int
          timeoutSeconds = int
        }
        resourceRequests = {
          cpu = "string"
          memory = "string"
        }
        scale = {
          maxReplicas = int
          minReplicas = int
          rules = [
            {
              azureQueue = {
                auth = [
                  {
                    secretRef = "string"
                    triggerParameter = "string"
                  }
                ]
                queueLength = int
                queueName = "string"
              }
              custom = {
                auth = [
                  {
                    secretRef = "string"
                    triggerParameter = "string"
                  }
                ]
                metadata = {}
                type = "string"
              }
              http = {
                auth = [
                  {
                    secretRef = "string"
                    triggerParameter = "string"
                  }
                ]
                metadata = {}
              }
              name = "string"
              tcp = {
                auth = [
                  {
                    secretRef = "string"
                    triggerParameter = "string"
                  }
                ]
                metadata = {}
              }
            }
          ]
        }
        startupProbe = {
          disableProbe = bool
          failureThreshold = int
          initialDelaySeconds = int
          periodSeconds = int
          probeAction = {
            type = "string"
            // For remaining properties, see ProbeAction objects
          }
          successThreshold = int
          timeoutSeconds = int
        }
        terminationGracePeriodSeconds = int
      }
      source = {
        version = "string"
        type = "string"
        // For remaining properties, see UserSourceInfo objects
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

Obiekty ProbeAction

Ustaw właściwość type , aby określić typ obiektu.

W przypadku narzędzia ExecAction użyj:

  type = "ExecAction"
  command = [
    "string"
  ]

W przypadku funkcji HTTPGetAction użyj:

  type = "HTTPGetAction"
  path = "string"
  scheme = "string"

W przypadku protokołu TCPSocketAction użyj:

  type = "TCPSocketAction"

Obiekty UserSourceInfo

Ustaw właściwość type , aby określić typ obiektu.

W przypadku elementu BuildResult użyj:

  type = "BuildResult"
  buildResultId = "string"

W przypadku kontenera użyj:

  type = "Container"
  customContainer = {
    args = [
      "string"
    ]
    command = [
      "string"
    ]
    containerImage = "string"
    imageRegistryCredential = {
      password = "string"
      username = "string"
    }
    languageFramework = "string"
    server = "string"
  }

W przypadku pliku Jar użyj polecenia:

  type = "Jar"
  jvmOptions = "string"
  relativePath = "string"
  runtimeVersion = "string"

W przypadku narzędzia NetCoreZip użyj:

  type = "NetCoreZip"
  netCoreMainEntryPath = "string"
  relativePath = "string"
  runtimeVersion = "string"

W obszarze Źródło użyj:

  type = "Source"
  artifactSelector = "string"
  relativePath = "string"
  runtimeVersion = "string"

Wartości właściwości

Spring/apps/deployments

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: aplikacje
sku Jednostka SKU zasobu wdrożenia Numer jednostki magazynowej
properties Właściwości zasobu wdrożenia DeploymentResourceProperties

DeploymentResourceProperties

Nazwa Opis Wartość
aktywne Wskazuje, czy wdrożenie jest aktywne bool
deploymentSettings Ustawienia wdrożenia wdrożenia DeploymentSettings
source Przekazane informacje o źródle wdrożenia. UserSourceInfo

DeploymentSettings

Nazwa Opis Wartość
addonConfigs Kolekcja dodatków object
containerProbeSettings Ustawienia sondy kondycji i gotowości kontenera ContainerProbeSettings
environmentVariables Kolekcja zmiennych środowiskowych object
livenessProbe Okresowa sonda aktualności wystąpienia aplikacji. Wystąpienie aplikacji zostanie ponownie uruchomione, jeśli sonda zakończy się niepowodzeniem. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
gotowośćProbe Okresowa sonda gotowości usługi App Instance Service. Wystąpienie aplikacji zostanie usunięte z punktów końcowych usługi, jeśli sonda zakończy się niepowodzeniem. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
resourceRequests Żądana ilość zasobów dla wymaganego procesora CPU i pamięci. Zaleca się, aby użycie tego pola do reprezentowania wymaganego procesora CPU i pamięci oznaczało, że stary procesor i pamięćInGB zostaną wycofane później. ResourceRequests
scale Skalowanie właściwości dla wystąpienia aplikacji Azure Spring Apps. Skalowanie
startupProbe StartupProbe wskazuje, że wystąpienie aplikacji zostało pomyślnie zainicjowane. Jeśli zostanie określony, żadne inne sondy nie zostaną wykonane do momentu pomyślnego zakończenia. Jeśli ta sonda zakończy się niepowodzeniem, zasobnik zostanie uruchomiony ponownie, tak jak w przypadku niepowodzenia livenessProbe. Może to służyć do zapewnienia różnych parametrów sondy na początku cyklu życia wystąpienia aplikacji, gdy ładowanie danych lub ciepło pamięci podręcznej może zająć dużo czasu niż podczas operacji na stałym stanie. Nie można tego zaktualizować. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Sonda
terminationGracePeriodSeconds Opcjonalny czas trwania w sekundach, który wystąpienie aplikacji musi zostać zakończone w sposób ciągły. Może zostać zmniejszony w żądaniu usuwania. Wartość musi być nie ujemną liczbą całkowitą. Wartość zero wskazuje, że zatrzymaj się natychmiast za pośrednictwem sygnału zabijania (brak możliwości zamknięcia). Jeśli ta wartość jest zerowa, zostanie użyty domyślny okres prolongaty. Okres prolongaty to czas trwania w sekundach po wysłaniu sygnału zakończenia procesów uruchomionych w wystąpieniu aplikacji i czasie, kiedy procesy są wymuszone zatrzymane za pomocą sygnału zabijania. Ustaw tę wartość dłużej niż oczekiwany czas oczyszczania procesu. Wartość domyślna to 90 sekund. int

ContainerProbeSettings

Nazwa Opis Wartość
disableProbe Wskazuje, czy wyłączyć sondę utrzymania i gotowości bool

Sonda

Nazwa Opis Wartość
disableProbe Określ, czy sonda jest wyłączona. bool (wymagane)
failureThreshold Minimalna liczba kolejnych niepowodzeń dla sondy, które mają zostać uznane za zakończone niepowodzeniem po pomyślnym zakończeniu. Wartość minimalna to 1. int
initialDelaySeconds Liczba sekund po uruchomieniu wystąpienia aplikacji przed zainicjowaniem sond. Więcej informacji: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes int
periodSeconds Jak często (w sekundach) wykonać sondę. Wartość minimalna to 1. int
probeAction Akcja sondy. SondaAction
successThreshold Minimalna liczba kolejnych sukcesów dla sondy, która ma zostać uznana za pomyślną po niepodaniu. Musi być 1 dla utrzymania i uruchamiania. Wartość minimalna to 1. int
timeoutSeconds Liczba sekund, po których sonda upłynął limit czasu. Wartość minimalna to 1. int

SondaAction

Nazwa Opis Wartość
typ Ustawianie typu obiektu ExecAction
HTTPGetAction
TCPSocketAction (wymagane)

ExecAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "ExecAction" (wymagane)
command Polecenie jest wierszem polecenia do wykonania wewnątrz kontenera, katalog roboczy dla polecenia jest główny ('/') w systemie plików kontenera. Polecenie nie jest uruchamiane wewnątrz powłoki, więc tradycyjne instrukcje powłoki (','itp.) nie będą działać. Aby użyć powłoki, należy jawnie wywołać do tej powłoki. Stan wyjścia 0 jest traktowany jako żywy/zdrowy i niezerowy jest w złej kondycji. ciąg[]

HttpGetAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "HTTPGetAction" (wymagane)
path Ścieżka dostępu do serwera HTTP. ciąg
schemat Schemat używany do nawiązywania połączenia z hostem. Wartość domyślna to HTTP.

Możliwe wartości wyliczenia:
- "HTTP" oznacza, że używany schemat będzie http://
- "HTTPS" oznacza, że używany schemat będzie https://		 "HTTP"
"HTTPS"

TCPSocketAction

Nazwa Opis Wartość
typ Typ akcji do wykonania w celu przeprowadzenia kontroli kondycji. "TCPSocketAction" (wymagane)

ResourceRequests

Nazwa Opis Wartość
Procesora Wymagany procesor CPU. 1 rdzeń może być reprezentowany przez 1 lub 1000m. Powinno to być 500 m lub 1 dla warstwy Podstawowa, a {500m, 1, 2, 3, 4} dla warstwy Standardowa. ciąg
pamięć Wymagana pamięć. 1 GB może być reprezentowane przez 1Gi lub 1024Mi. Powinna to być wartość {512Mi, 1Gi, 2Gi} dla warstwy Podstawowa i {512Mi, 1Gi, 2Gi, ..., 8Gi} dla warstwy Standardowa. ciąg

Skalowanie

Nazwa Opis Wartość
maxReplicas Opcjonalny. Maksymalna liczba replik kontenerów. Wartość domyślna to 10, jeśli nie zostanie ustawiona. int
minReplicas Opcjonalny. Minimalna liczba replik kontenerów. int
rules Reguły skalowania. ScaleRule[]

ScaleRule

Nazwa Opis Wartość
azureQueue Skalowanie oparte na kolejce platformy Azure. QueueScaleRule
niestandardowe Niestandardowa reguła skalowania. CustomScaleRule
http Skalowanie na podstawie żądań HTTP. HttpScaleRule
name Nazwa reguły skalowania ciąg
Tcp Skalowanie oparte na żądaniach TCP. TcpScaleRule

QueueScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania kolejek. ScaleRuleAuth[]
queueLength Długość kolejki. int
Queuename Nazwa kolejki. ciąg

ScaleRuleAuth

Nazwa Opis Wartość
secretRef Nazwa wpisu tajnego usługi Azure Spring Apps App Instance, z którego chcesz ściągnąć parametry uwierzytelniania. ciąg
triggerParameter Parametr wyzwalacza, który używa wpisu tajnego ciąg

CustomScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania niestandardowego. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące niestandardową regułę skalowania. object
typ Typ reguły skalowania niestandardowego
np. azure-servicebus, redis itp.
 ciąg

HttpScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania niestandardowego. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące regułę skalowania http. object

TcpScaleRule

Nazwa Opis Wartość
Auth Wpisy tajne uwierzytelniania dla reguły skalowania tcp. ScaleRuleAuth[]
metadane Właściwości metadanych opisujące regułę skalowania tcp. object

UserSourceInfo

Nazwa Opis Wartość
Wersja Wersja źródła ciąg
typ Ustawianie typu obiektu BuildResult
Kontener
Jar
NetCoreZip
Źródło (wymagane)

BuildResultUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "BuildResult" (wymagane)
buildResultId Identyfikator zasobu istniejącego pomyślnego wyniku kompilacji w ramach tego samego wystąpienia spring. ciąg

CustomContainerUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Kontener" (wymagany)
customContainer Niestandardowy ładunek kontenera CustomContainer

CustomContainer

Nazwa Opis Wartość
args Argumenty do punktu wejścia. CmD obrazu platformy Docker jest używany, jeśli nie jest to podane. ciąg[]
command Tablica punktów wejścia. Nie jest wykonywane w powłoce. Jeśli nie podano tego elementu, używany jest punkt WEJŚCIA obrazu platformy Docker. ciąg[]
containerImage Obraz kontenera kontenera niestandardowego. Powinno to mieć postać {repository}:{tag} bez nazwy serwera rejestru ciąg
imageRegistryCredential Poświadczenie rejestru obrazów ImageRegistryCredential
languageFramework Struktura językowa przekazanego obrazu kontenera ciąg
serwer Nazwa rejestru zawierającego obraz kontenera ciąg

ImageRegistryCredential

Nazwa Opis Wartość
hasło Hasło poświadczeń rejestru obrazów ciąg
nazwa użytkownika Nazwa użytkownika poświadczeń rejestru obrazów ciąg

JarUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Jar" (wymagany)
jvmOptions Parametr JVM ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku Jar ciąg

NetCoreZipUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "NetCoreZip" (wymagane)
netCoreMainEntryPath Ścieżka do pliku wykonywalnego .NET względem katalogu głównego zip ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku .Net ciąg

SourceUploadedUserSourceInfo

Nazwa Opis Wartość
typ Typ przekazanego źródła "Źródło" (wymagane)
artifactSelector Selektor artefaktu, który ma być używany do wdrożenia w projektach z wieloma modułami. Powinno to być
ścieżka względna do docelowego modułu/projektu.		 ciąg
relativePath Ścieżka względna magazynu, który przechowuje źródło ciąg
runtimeVersion Wersja środowiska uruchomieniowego pliku źródłowego ciąg

SKU

Nazwa Opis Wartość
capacity Bieżąca pojemność zasobu docelowego int
name Nazwa jednostki SKU ciąg
tier Warstwa jednostki SKU ciąg