Deployments - List
Verarbeitet Anforderungen zum Auflisten aller Ressourcen in einer App.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments?api-version=2023-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments?api-version=2023-12-01&version={version}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
app
|
path | True |
string |
Der Name der App-Ressource. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden. |
service
|
path | True |
string |
Der Name der Dienstressource. Regex pattern: |
subscription
|
path | True |
string |
Ruft die Abonnement-ID ab, die das Microsoft Azure-Abonnement eindeutig identifiziert. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
version
|
query |
string[] |
Version der bereitstellungen, die aufgelistet werden sollen |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolg. Die Antwort beschreibt die Liste der Bereitstellungen in der App. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Deployments_List
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments?api-version=2023-12-01
Sample Response
{
"value": [
{
"properties": {
"source": {
"type": "Source",
"relativePath": "resources/a172cedcae47474b615c54d510a5d84a8dea3032e958587430b413538be3f333-2019082605-e3095339-1723-44b7-8b5e-31b1003978bc",
"version": "1.0",
"artifactSelector": "sub-module-1"
},
"deploymentSettings": {
"resourceRequests": {
"cpu": "1000m",
"memory": "3Gi"
},
"environmentVariables": {
"env": "test"
},
"apms": [
{
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apms/myappinsights"
}
]
},
"provisioningState": "Succeeded",
"status": "Running",
"active": true,
"instances": [
{
"name": "instance1",
"status": "Running",
"discoveryStatus": "pending",
"startTime": "2020-08-26T01:55:02Z"
}
]
},
"sku": {
"name": "S0",
"tier": "Standard",
"capacity": 1
},
"systemData": {
"createdBy": "sample-user",
"createdByType": "User",
"createdAt": "2021-08-11T03:16:03.944Z",
"lastModifiedBy": "sample-user",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-08-11T03:17:03.944Z"
},
"type": "Microsoft.AppPlatform/Spring/apps/deployments",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/deployments/mydeployment",
"name": "mydeployment"
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Apm |
Ein Verweis auf die APM |
Build |
Verweis auf ein Buildergebnis |
Cloud |
Eine Fehlerantwort vom Dienst. |
Cloud |
Eine Fehlerantwort vom Dienst. |
Container |
Einstellungen für Container für Live- und Bereitschaftstests |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Custom |
Benutzerdefinierte Containernutzlast |
Custom |
Informationen zur Benutzerdefinierten Containerbenutzerquelle |
Deployment |
Bereitstellungsnutzlast instance |
Deployment |
Ressourcennutzlast für die Bereitstellung |
Deployment |
Objekt, das ein Array von App-Ressourcen und einen möglichen Link für den nächsten Satz enthält |
Deployment |
Nutzlast der Bereitstellungsressourceneigenschaften |
Deployment |
Bereitstellungsstatus der Bereitstellung |
Deployment |
Status der Bereitstellung |
Deployment |
Nutzlast der Bereitstellungseinstellungen |
Exec |
ExecAction beschreibt eine Aktion "Im Container ausführen". |
HTTPGet |
HTTPGetAction beschreibt eine Aktion, die auf HTTP-Get-Anforderungen basiert. |
HTTPScheme |
Schema, das zum Herstellen einer Verbindung mit dem Host verwendet werden soll. Der Standardwert ist HTTP. Mögliche Enumerationswerte:
|
Image |
Anmeldeinformationen der Imageregistrierung |
last |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
Probe |
Der Test beschreibt eine Integritätsprüfung, die für eine App-Instanz ausgeführt werden soll, um zu bestimmen, ob sie aktiv ist oder bereit ist, Datenverkehr zu empfangen. |
Resource |
Anforderungsnutzlast für Bereitstellungsressourcen |
Sku |
SKU von Azure Spring Apps |
System |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
TCPSocket |
TCPSocketAction beschreibt eine Aktion, die auf dem Öffnen eines Sockets basiert. |
ApmReference
Ein Verweis auf die APM
Name | Typ | Beschreibung |
---|---|---|
resourceId |
string |
Ressourcen-ID des APM |
BuildResultUserSourceInfo
Verweis auf ein Buildergebnis
Name | Typ | Beschreibung |
---|---|---|
buildResultId |
string |
Ressourcen-ID eines vorhandenen erfolgreichen Buildergebnisses unter demselben Spring instance. |
type |
string:
Build |
Typ der hochgeladenen Quelle |
version |
string |
Version der Quelle |
CloudError
Eine Fehlerantwort vom Dienst.
Name | Typ | Beschreibung |
---|---|---|
error |
Eine Fehlerantwort vom Dienst. |
CloudErrorBody
Eine Fehlerantwort vom Dienst.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
details |
Eine Liste mit zusätzlichen Details zum Fehler. |
|
message |
string |
Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
target |
string |
Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist. |
ContainerProbeSettings
Einstellungen für Container für Live- und Bereitschaftstests
Name | Typ | Beschreibung |
---|---|---|
disableProbe |
boolean |
Gibt an, ob der Live- und Bereitschaftstest deaktiviert wird. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CustomContainer
Benutzerdefinierte Containernutzlast
Name | Typ | Beschreibung |
---|---|---|
args |
string[] |
Argumente für den Einstiegspunkt. Wenn dies nicht angegeben ist, wird die CMD des Docker-Images verwendet. |
command |
string[] |
Entrypoint-Array. Wird nicht innerhalb einer Shell ausgeführt. Der ENTRYPOINT des Docker-Images wird verwendet, wenn dies nicht angegeben wird. |
containerImage |
string |
Containerimage des benutzerdefinierten Containers. Dies sollte in der Form von vorliegen: ohne den Servernamen der Registrierung. |
imageRegistryCredential |
Anmeldeinformationen der Imageregistrierung |
|
languageFramework |
string |
Sprachframework des hochgeladenen Containerimages. Unterstützte Werte: "springboot", "", NULL. |
server |
string |
Der Name der Registrierung, die das Containerimage enthält |
CustomContainerUserSourceInfo
Informationen zur Benutzerdefinierten Containerbenutzerquelle
Name | Typ | Beschreibung |
---|---|---|
customContainer |
Benutzerdefinierte Containernutzlast |
|
type |
string:
Container |
Typ der hochgeladenen Quelle |
version |
string |
Version der Quelle |
DeploymentInstance
Bereitstellungsnutzlast instance
Name | Typ | Beschreibung |
---|---|---|
discoveryStatus |
string |
Ermittlung status des Bereitstellungs-instance |
name |
string |
Name des Bereitstellungs-instance |
reason |
string |
Fehlerursache der Bereitstellung instance |
startTime |
string |
Startzeit der Bereitstellung instance |
status |
string |
Status der bereitstellungs-instance |
zone |
string |
Informationen zur Verfügbarkeitszone der bereitstellungs instance |
DeploymentResource
Ressourcennutzlast für die Bereitstellung
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. |
name |
string |
Der Name der Ressource. |
properties |
Eigenschaften der Bereitstellungsressource |
|
sku |
SKU der Bereitstellungsressource |
|
systemData |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
|
type |
string |
Der Typ der Ressource. |
DeploymentResourceCollection
Objekt, das ein Array von App-Ressourcen und einen möglichen Link für den nächsten Satz enthält
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Der URL-Client sollte verwenden, um die nächste Seite abzurufen (pro serverseitigem Paging). Es ist vorerst NULL und wird für die zukünftige Verwendung hinzugefügt. |
value |
Sammlung von Bereitstellungsressourcen |
DeploymentResourceProperties
Nutzlast der Bereitstellungsressourceneigenschaften
Name | Typ | Beschreibung |
---|---|---|
active |
boolean |
Gibt an, ob die Bereitstellung aktiv ist. |
deploymentSettings |
Bereitstellungseinstellungen der Bereitstellung |
|
instances |
Eine Sammlung von Instanzen gehört zur Bereitstellung. |
|
provisioningState |
Bereitstellungsstatus der Bereitstellung |
|
source | UserSourceInfo: |
Die Quellinformationen der Bereitstellung wurden hochgeladen. |
status |
Status der Bereitstellung |
DeploymentResourceProvisioningState
Bereitstellungsstatus der Bereitstellung
Name | Typ | Beschreibung |
---|---|---|
Creating |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
DeploymentResourceStatus
Status der Bereitstellung
Name | Typ | Beschreibung |
---|---|---|
Running |
string |
|
Stopped |
string |
DeploymentSettings
Nutzlast der Bereitstellungseinstellungen
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
addonConfigs |
object |
Sammlung von Addons |
|
apms |
Sammlung von ApmReferences |
||
containerProbeSettings |
Einstellungen für Container für Live- und Bereitschaftstests |
||
environmentVariables |
object |
Sammlung von Umgebungsvariablen |
|
livenessProbe |
Regelmäßiger Test der App-Instanz-Live. Die App-Instanz wird neu gestartet, wenn der Test fehlschlägt. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
||
readinessProbe |
Regelmäßige Überprüfung der Bereitschaft des App-Instanzdiensts. Die App-Instanz wird von Dienstendpunkten entfernt, wenn der Test fehlschlägt. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
||
resourceRequests |
Die angeforderte Ressourcenmenge für die erforderliche CPU und den erforderlichen Arbeitsspeicher. Es wird empfohlen, dass die Verwendung dieses Felds zur Darstellung der erforderlichen CPU und des erforderlichen Arbeitsspeichers, des alten Felds cpu und memoryInGB später als veraltet gilt. |
||
startupProbe |
StartupProbe gibt an, dass die App-Instanz erfolgreich initialisiert wurde. Wenn angegeben, werden keine weiteren Tests ausgeführt, bis dies erfolgreich abgeschlossen ist. Wenn dieser Test fehlschlägt, wird der Pod neu gestartet, so als ob livenessProbe fehlgeschlagen wäre. Dies kann verwendet werden, um andere Testparameter zu Beginn des Lebenszyklus einer App-Instanz bereitzustellen, wenn das Laden von Daten oder das Aufwärmen eines Caches sehr lange dauern kann, als während des betriebsinternen Betriebs. Dies kann nicht aktualisiert werden. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
||
terminationGracePeriodSeconds |
integer |
90 |
Optionale Dauer in Sekunden, die die App-Instanz ordnungsgemäß beenden muss. Kann in der Löschanforderung verringert werden. Der Wert muss eine nicht negative ganze Zahl sein. Der Wert 0 gibt an, dass sofort über das Kill-Signal angehalten wird (keine Gelegenheit zum Herunterfahren). Wenn dieser Wert gleich null ist, wird stattdessen der standardmäßige Nachfristzeitraum verwendet. Die Karenzzeit ist die Dauer in Sekunden, nachdem die in der App-Instanz ausgeführten Prozesse ein Beendigungssignal gesendet haben, und der Zeitpunkt, zu dem die Prozesse mit einem Kill-Signal erzwungen angehalten werden. Legen Sie für diesen Wert eine längere Zeit als die erwartete Bereinigungszeit für Ihren Prozess fest. Der Standardwert ist 90 Sekunden. |
ExecAction
ExecAction beschreibt eine Aktion "Im Container ausführen".
Name | Typ | Beschreibung |
---|---|---|
command |
string[] |
Der Befehl ist die Befehlszeile, die innerhalb des Containers ausgeführt werden soll. Das Arbeitsverzeichnis für den Befehl ist stamm ("/") im Dateisystem des Containers. Der Befehl wird nicht innerhalb einer Shell ausgeführt, sodass herkömmliche Shellanweisungen ("|" usw.) nicht funktionieren. Um eine Shell zu verwenden, müssen Sie diese Shell explizit aufrufen. Exit status von 0 wird als live/fehlerfrei behandelt, und ungleich 0 ist fehlerhaft. |
type | string: |
Der Typ der Aktion, die zum Durchführen der Integritätsprüfung ausgeführt werden soll. |
HTTPGetAction
HTTPGetAction beschreibt eine Aktion, die auf HTTP-Get-Anforderungen basiert.
Name | Typ | Beschreibung |
---|---|---|
path |
string |
Pfad zum Zugriff auf dem HTTP-Server. |
scheme |
Schema, das zum Herstellen einer Verbindung mit dem Host verwendet werden soll. Der Standardwert ist HTTP. Mögliche Enumerationswerte:
|
|
type | string: |
Der Typ der Aktion, die zum Durchführen der Integritätsprüfung ausgeführt werden soll. |
HTTPSchemeType
Schema, das zum Herstellen einer Verbindung mit dem Host verwendet werden soll. Der Standardwert ist HTTP.
Mögliche Enumerationswerte:
"HTTP"
bedeutet, dass das verwendete Schema http://"HTTPS"
bedeutet, dass das verwendete Schema https://
Name | Typ | Beschreibung |
---|---|---|
HTTP |
string |
|
HTTPS |
string |
ImageRegistryCredential
Anmeldeinformationen der Imageregistrierung
Name | Typ | Beschreibung |
---|---|---|
password |
string |
Das Kennwort der Anmeldeinformationen für die Imageregistrierung |
username |
string |
Der Benutzername der Anmeldeinformationen für die Imageregistrierung |
lastModifiedByType
Der Identitätstyp, der die Ressource zuletzt geändert hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Probe
Der Test beschreibt eine Integritätsprüfung, die für eine App-Instanz ausgeführt werden soll, um zu bestimmen, ob sie aktiv ist oder bereit ist, Datenverkehr zu empfangen.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
disableProbe |
boolean |
False |
Geben Sie an, ob der Test deaktiviert ist. |
failureThreshold |
integer |
Minimale aufeinanderfolgende Fehler, damit der Test nach dem Erfolgreichen als fehlgeschlagen gilt. Der Mindestwert ist 1. |
|
initialDelaySeconds |
integer |
Anzahl der Sekunden nach dem Starten der App-Instanz, bevor Tests initiiert werden. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
periodSeconds |
integer |
Gibt an, wie häufig (in Sekunden) ein Test durchgeführt werden soll. Der Mindestwert ist 1. |
|
probeAction | ProbeAction: |
Die Aktion des Tests. |
|
successThreshold |
integer |
Minimale aufeinanderfolgende Erfolge, damit der Test nach einem Fehler als erfolgreich angesehen wird. Muss 1 sein, um live zu sein und zu starten. Der Mindestwert ist 1. |
|
timeoutSeconds |
integer |
Anzahl der Sekunden, nach denen das Zeitüberschreitungsintervall für den Test aufgetreten ist. Der Mindestwert ist 1. |
ResourceRequests
Anforderungsnutzlast für Bereitstellungsressourcen
Name | Typ | Beschreibung |
---|---|---|
cpu |
string |
Erforderliche CPU. 1 Kern kann durch 1 oder 1000m dargestellt werden. Dies sollte 500m oder 1 für den Tarif Basic und {500m, 1, 2, 3, 4} für den Tarif Standard sein. |
memory |
string |
Erforderlicher Arbeitsspeicher. 1 GB kann durch 1Gi oder 1024Mi dargestellt werden. Dies sollte {512Mi, 1Gi, 2Gi} für den Tarif Basic und {512Mi, 1Gi, 2Gi, ..., 8Gi} für den Tarif Standard sein. |
Sku
SKU von Azure Spring Apps
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
capacity |
integer |
Aktuelle Kapazität der Zielressource |
|
name |
string |
S0 |
Name der SKU |
tier |
string |
Standard |
Ebene der SKU |
SystemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Zeitstempel der Ressourcenänderung (UTC). |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
TCPSocketAction
TCPSocketAction beschreibt eine Aktion, die auf dem Öffnen eines Sockets basiert.
Name | Typ | Beschreibung |
---|---|---|
type | string: |
Der Typ der Aktion, die zum Durchführen der Integritätsprüfung ausgeführt werden soll. |