Applications - List
Ruft die Liste der Anwendungsressourcen ab, die in der angegebenen Service Fabric-Clusterressource erstellt wurden.
Ruft alle Anwendungsressourcen ab, die erstellt oder im Prozess der Erstellung in der Service Fabric-Clusterressource erstellt werden.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications?api-version=2023-11-01-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
cluster
|
path | True |
string |
Der Name der Clusterressource. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. |
subscription
|
path | True |
string |
Der Bezeichner des Kundenabonnements. |
api-version
|
query | True |
string |
Die Version der Service Fabric-Ressourcenanbieter-API. Dies ist ein erforderlicher Parameter, und der Wert muss für diese Spezifikation "2023-11-01-preview" sein. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der Vorgang wurde erfolgreich abgeschlossen. |
|
Other Status Codes |
Die detaillierte Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
Get a list of application resources
Beispielanforderung
Beispiel für eine Antwort
{
"value": [
{
"type": "applications",
"location": "eastus",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp",
"name": "myCluster",
"tags": {},
"etag": "W/\"636462502180261858\"",
"properties": {
"provisioningState": "Updating",
"typeName": "myAppType",
"typeVersion": "1.0",
"removeApplicationCapacity": false,
"metrics": [
{
"name": "metric1",
"reservationCapacity": 1,
"maximumCapacity": 3,
"totalApplicationCapacity": 5
}
]
}
}
],
"nextLink": ""
}
Definitionen
Name | Beschreibung |
---|---|
Application |
Beschreibt Kapazitätsinformationen für eine benutzerdefinierte Metrik für den Ressourcenausgleich. Dies kann verwendet werden, um den Gesamtverbrauch dieser Metrik durch die Dienste dieser Anwendung zu begrenzen. |
Application |
Die Anwendungsressource. |
Application |
Die Liste der Anwendungsressourcen. |
Application |
Beschreibt die Richtlinie für ein überwachtes Anwendungsupgrade. |
Application |
|
Arm |
Definiert eine Integritätsrichtlinie, die verwendet wird, um die Integrität einer Anwendung oder einer seiner untergeordneten Entitäten auszuwerten. |
Arm |
Die Richtlinie zur Überwachung des Anwendungsupgrades |
Arm |
Stellt die Integritätsrichtlinie dar, die verwendet wird, um den Status von Diensten zu bewerten, die zu einem Diensttyp gehören. |
Arm |
Der Aktivierungsmodus des Dienstpakets |
Error |
Die Struktur des Fehlers. |
Error |
Die Fehlerdetails. |
Managed |
Beschreibt die verwalteten Identitäten für eine Azure-Ressource. |
Managed |
Der Typ der verwalteten Identität für die Ressource. |
Rolling |
Der Modus, der zum Überwachen des Zustands während eines rollierenden Upgrades verwendet wird. Die Werte sind "UnmonitoredAuto", "UnmonitoredManual" und "Monitored". |
System |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
User |
ApplicationMetricDescription
Beschreibt Kapazitätsinformationen für eine benutzerdefinierte Metrik für den Ressourcenausgleich. Dies kann verwendet werden, um den Gesamtverbrauch dieser Metrik durch die Dienste dieser Anwendung zu begrenzen.
Name | Typ | Beschreibung |
---|---|---|
maximumCapacity |
integer (int64) |
Die maximale Knotenkapazität für die Service Fabric-Anwendung. Dies ist die maximale Last für eine Instanz dieser Anwendung auf einem einzelnen Knoten. Selbst wenn die Kapazität des Knotens größer als dieser Wert ist, schränkt Service Fabric die Gesamtlast der Dienste innerhalb der Anwendung auf jeden Knoten auf diesen Wert ein. Bei Festlegung auf Null ist die Kapazität für diese Metrik für jeden Knoten unbegrenzt. Beim Erstellen einer neuen Anwendung mit definierter Anwendungskapazität muss das Produkt von MaximumNodes und dieser Wert immer kleiner oder gleich "TotalApplicationCapacity" sein. Beim Aktualisieren einer vorhandenen Anwendung mit Anwendungskapazität muss das Produkt von MaximumNodes und dieser Wert immer kleiner oder gleich "TotalApplicationCapacity" sein. |
name |
string |
Der Name der Metrik. |
reservationCapacity |
integer (int64) |
Die Knotenreservierungskapazität für die Service Fabric-Anwendung. Dies ist die Last, die für Knoten reserviert ist, die Instanzen dieser Anwendung aufweisen. Wenn MinimumNodes angegeben ist, ist das Produkt dieser Werte die Kapazität im Cluster für die Anwendung reserviert. Wenn dieser Wert auf Null festgelegt ist, ist keine Kapazität für diese Metrik reserviert. Beim Festlegen der Anwendungskapazität oder beim Aktualisieren der Anwendungskapazität; Dieser Wert muss kleiner oder gleich "MaximumCapacity" für jede Metrik sein. |
totalApplicationCapacity |
integer (int64) |
Die gesamtmetrische Kapazität für die Service Fabric-Anwendung. Dies ist die gesamtmetrische Kapazität für diese Anwendung im Cluster. Service Fabric versucht, die Anzahl der Dienste innerhalb der Anwendung auf diesen Wert zu beschränken. Beim Erstellen einer neuen Anwendung mit definierter Anwendungskapazität muss das Produkt von MaximumNodes und MaximumCapacity immer kleiner oder gleich diesem Wert sein. |
ApplicationResource
Die Anwendungsressource.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
etag |
string |
Azure-Ressourcen-Etag. |
|
id |
string |
Azure-Ressourcenbezeichner. |
|
identity |
Beschreibt die verwalteten Identitäten für eine Azure-Ressource. |
||
location |
string |
Er ist in der neuen API veraltet, der Ressourcenspeicherort hängt von der übergeordneten Ressource ab. |
|
name |
string |
Azure-Ressourcenname. |
|
properties.managedIdentities |
Liste der vom Benutzer zugewiesenen Identitäten für die Anwendung, die jeweils einem Anzeigenamen zugeordnet sind. |
||
properties.maximumNodes |
integer (int64) minimum: 0 |
0 |
Die maximale Anzahl von Knoten, bei denen Service Fabric Kapazität für diese Anwendung reserviert. Beachten Sie, dass dies nicht bedeutet, dass die Dienste dieser Anwendung auf all diesen Knoten platziert werden. Standardmäßig ist der Wert dieser Eigenschaft null und bedeutet, dass die Dienste auf einem beliebigen Knoten platziert werden können. |
properties.metrics |
Liste der Metriken zur Anwendungskapazität. |
||
properties.minimumNodes |
integer (int64) minimum: 0 |
Die Mindestanzahl von Knoten, bei denen Service Fabric kapazität für diese Anwendung reservieren wird. Beachten Sie, dass dies nicht bedeutet, dass die Dienste dieser Anwendung auf all diesen Knoten platziert werden. Wenn diese Eigenschaft auf Null festgelegt ist, wird keine Kapazität reserviert. Der Wert dieser Eigenschaft darf nicht größer als der Wert der MaximumNodes-Eigenschaft sein. |
|
properties.parameters |
object |
Liste der Anwendungsparameter mit überschriebenen Werten aus den im Anwendungsmanifest angegebenen Standardwerten. |
|
properties.provisioningState |
string |
Der aktuelle Bereitstellungs- oder Bereitstellungsstatus, der nur in der Antwort angezeigt wird |
|
properties.removeApplicationCapacity |
boolean |
Entfernen Sie die aktuellen Anwendungskapazitätseinstellungen. |
|
properties.typeName |
string |
Der Name des Anwendungstyps gemäß definition im Anwendungsmanifest. |
|
properties.typeVersion |
string |
Die Version des Anwendungstyps, wie im Anwendungsmanifest definiert. |
|
properties.upgradePolicy |
Beschreibt die Richtlinie für ein überwachtes Anwendungsupgrade. |
||
systemData |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
||
tags |
object |
Azure-Ressourcentags. |
|
type |
string |
Azure-Ressourcentyp. |
ApplicationResourceList
Die Liste der Anwendungsressourcen.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
URL zum Abrufen des nächsten Satzes von Anwendungslistenergebnissen, falls vorhanden. |
value |
Die Anwendungsressource. |
ApplicationUpgradePolicy
Beschreibt die Richtlinie für ein überwachtes Anwendungsupgrade.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
applicationHealthPolicy |
Definiert eine Integritätsrichtlinie, die verwendet wird, um die Integrität einer Anwendung oder einer seiner untergeordneten Entitäten auszuwerten. |
||
forceRestart |
boolean |
False |
Wenn true, werden Prozesse während des Upgrades erzwungen neu gestartet, auch wenn sich die Codeversion nicht geändert hat (das Upgrade ändert nur die Konfiguration oder Daten). |
recreateApplication |
boolean |
Bestimmt, ob die Anwendung beim Update neu erstellt werden soll. Wenn wert=true, sind die restlichen Upgraderichtlinienparameter nicht zulässig und führen zu Einem Verfügbarkeitsverlust. |
|
rollingUpgradeMonitoringPolicy |
Die Richtlinie zur Überwachung des Anwendungsupgrades |
||
upgradeMode | Monitored |
Der Modus, der zum Überwachen des Zustands während eines rollierenden Upgrades verwendet wird. Die Werte sind "UnmonitoredAuto", "UnmonitoredManual" und "Monitored". |
|
upgradeReplicaSetCheckTimeout |
string |
Die maximale Zeit, um die Verarbeitung einer Upgradedomäne zu blockieren und den Verlust der Verfügbarkeit zu verhindern, wenn unerwartete Probleme auftreten. Wenn dieses Timeout abläuft, wird die Verarbeitung der Upgradedomäne unabhängig von Verfügbarkeitsverlustproblemen fortgesetzt. Das Timeout wird am Anfang jeder Upgradedomäne zurückgesetzt. Gültige Werte liegen zwischen 0 und 42949672925 einschließlich. (nicht signierte 32-Bit-Ganzzahl). |
ApplicationUserAssignedIdentity
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Anzeigename der vom Benutzer zugewiesenen Identität. |
principalId |
string |
Die Prinzipal-ID der vom Benutzer zugewiesenen Identität. |
ArmApplicationHealthPolicy
Definiert eine Integritätsrichtlinie, die verwendet wird, um die Integrität einer Anwendung oder einer seiner untergeordneten Entitäten auszuwerten.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
considerWarningAsError |
boolean |
False |
Gibt an, ob Warnungen mit demselben Schweregrad wie Fehler behandelt werden. |
defaultServiceTypeHealthPolicy |
Die Standardmäßig zum Auswerten der Integrität eines Diensttyps verwendete Integritätsrichtlinie. |
||
maxPercentUnhealthyDeployedApplications |
integer (int32) |
0 |
Der maximal zulässige Prozentsatz der nicht fehlerhaften bereitgestellten Anwendungen. Zulässige Werte sind Bytewerte von Null bis 100. Der Prozentsatz stellt den maximalen tolerierten Prozentsatz der bereitgestellten Anwendungen dar, die fehlerhaft sein können, bevor die Anwendung als Fehler betrachtet wird. Dies wird berechnet, indem die Anzahl der ungesund bereitgestellten Anwendungen über die Anzahl der Knoten geteilt wird, auf denen die Anwendung derzeit im Cluster bereitgestellt wird. Die Berechnung wird aufgerundet, um einen Fehler bei einer kleinen Anzahl von Knoten zu tolerieren. Der Standardprozentsatz ist Null. |
serviceTypeHealthPolicyMap |
<string,
Arm |
Die Zuordnung mit der Diensttypintegritätsrichtlinie pro Diensttypname. Die Karte ist standardmäßig leer. |
ArmRollingUpgradeMonitoringPolicy
Die Richtlinie zur Überwachung des Anwendungsupgrades
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
failureAction |
Der Aktivierungsmodus des Dienstpakets |
||
healthCheckRetryTimeout |
string |
PT0H10M0S |
Der Zeitraum, um die Integritätsauswertung erneut zu versuchen, wenn die Anwendung oder der Cluster nicht korrekt ist, bevor FailureAction ausgeführt wird. Sie wird zunächst als Zeichenfolge interpretiert, die eine ISO 8601-Dauer darstellt. Wenn dies fehlschlägt, wird sie als Zahl interpretiert, die die Gesamtanzahl von Millisekunden darstellt. |
healthCheckStableDuration |
string |
PT0H2M0S |
Die Zeitspanne, die die Anwendung oder der Cluster fehlerfrei bleiben muss, bevor das Upgrade zur nächsten Upgradedomäne fortgesetzt wird. Sie wird zunächst als Zeichenfolge interpretiert, die eine ISO 8601-Dauer darstellt. Wenn dies fehlschlägt, wird sie als Zahl interpretiert, die die Gesamtanzahl von Millisekunden darstellt. |
healthCheckWaitDuration |
string |
0 |
Die Zeitspanne, die nach Abschluss einer Upgradedomäne gewartet werden muss, bevor Integritätsrichtlinien angewendet werden. Sie wird zunächst als Zeichenfolge interpretiert, die eine ISO 8601-Dauer darstellt. Wenn dies fehlschlägt, wird sie als Zahl interpretiert, die die Gesamtanzahl von Millisekunden darstellt. |
upgradeDomainTimeout |
string |
P10675199DT02H48M05.4775807S |
Der Zeitraum, in dem jede Upgradedomäne abgeschlossen werden muss, bevor FailureAction ausgeführt wird. Sie wird zunächst als Zeichenfolge interpretiert, die eine ISO 8601-Dauer darstellt. Wenn dies fehlschlägt, wird sie als Zahl interpretiert, die die Gesamtanzahl von Millisekunden darstellt. |
upgradeTimeout |
string |
P10675199DT02H48M05.4775807S |
Der Zeitraum, in dem das gesamte Upgrade abgeschlossen werden muss, bevor FailureAction ausgeführt wird. Sie wird zunächst als Zeichenfolge interpretiert, die eine ISO 8601-Dauer darstellt. Wenn dies fehlschlägt, wird sie als Zahl interpretiert, die die Gesamtanzahl von Millisekunden darstellt. |
ArmServiceTypeHealthPolicy
Stellt die Integritätsrichtlinie dar, die verwendet wird, um den Status von Diensten zu bewerten, die zu einem Diensttyp gehören.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
maxPercentUnhealthyPartitionsPerService |
integer (int32) minimum: 0maximum: 100 |
0 |
Der maximale Prozentsatz der Partitionen pro Dienst darf nicht fehlerfrei sein, bevor Die Anwendung als Fehler betrachtet wird. |
maxPercentUnhealthyReplicasPerPartition |
integer (int32) minimum: 0maximum: 100 |
0 |
Der maximale Prozentsatz der Replikate pro Partition darf nicht fehlerfrei sein, bevor Die Anwendung als Fehler betrachtet wird. |
maxPercentUnhealthyServices |
integer (int32) minimum: 0maximum: 100 |
0 |
Der maximale Prozentsatz der Dienste, die nicht fehlerfrei sein dürfen, bevor Ihre Anwendung als Fehler betrachtet wird. |
ArmUpgradeFailureAction
Der Aktivierungsmodus des Dienstpakets
Wert | Beschreibung |
---|---|
Manual |
Gibt an, dass eine manuelle Reparatur vom Administrator ausgeführt werden muss, wenn das Upgrade fehlschlägt. Service Fabric fährt nicht automatisch mit der nächsten Upgradedomäne fort. |
Rollback |
Gibt an, dass ein Rollback des Upgrades von Service Fabric ausgeführt wird, wenn das Upgrade fehlschlägt. |
ErrorModel
Die Struktur des Fehlers.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Fehlerdetails. |
ErrorModelError
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
message |
string |
Die Fehlermeldung. |
ManagedIdentity
Beschreibt die verwalteten Identitäten für eine Azure-Ressource.
Name | Typ | Beschreibung |
---|---|---|
principalId |
string |
Die Prinzipal-ID der verwalteten Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt. |
tenantId |
string |
Die Mandanten-ID der verwalteten Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt. |
type |
Der Typ der verwalteten Identität für die Ressource. |
|
userAssignedIdentities |
<string,
User |
Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ManagedIdentityType
Der Typ der verwalteten Identität für die Ressource.
Wert | Beschreibung |
---|---|
None |
Gibt an, dass der Ressource keine Identität zugeordnet ist. |
SystemAssigned |
Gibt an, dass die vom System zugewiesene Identität der Ressource zugeordnet ist. |
SystemAssigned, UserAssigned |
Gibt an, dass sowohl die vom System zugewiesene als auch die vom Benutzer zugewiesene Identität der Ressource zugeordnet sind. |
UserAssigned |
Gibt an, dass die vom Benutzer zugewiesene Identität der Ressource zugeordnet ist. |
RollingUpgradeMode
Der Modus, der zum Überwachen des Zustands während eines rollierenden Upgrades verwendet wird. Die Werte sind "UnmonitoredAuto", "UnmonitoredManual" und "Monitored".
Wert | Beschreibung |
---|---|
Invalid |
Gibt an, dass der Upgrademodus ungültig ist. Alle Service Fabric-Enumerationen weisen den ungültigen Typ auf. Der Wert ist Null. |
Monitored |
Das Upgrade wird nach Abschluss jeder Upgradedomäne beendet und die Integrität automatisch überwacht, bevor Sie fortfahren. Der Wert ist 3. |
UnmonitoredAuto |
Das Upgrade wird automatisch fortgesetzt, ohne eine Integritätsüberwachung durchzuführen. Der Wert ist 1 |
UnmonitoredManual |
Das Upgrade wird nach Abschluss jeder Upgradedomäne beendet und bietet die Möglichkeit, den Status manuell zu überwachen, bevor Sie fortfahren. Der Wert ist 2. |
SystemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string (date-time) |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
string |
Der Identitätstyp, der die Ressource erstellt hat. |
lastModifiedAt |
string (date-time) |
Der Zeitstempel der letzten Änderung der Ressource (UTC). |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
string |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
UserAssignedIdentity
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
Die Client-ID der vom Benutzer zugewiesenen Identität. |
principalId |
string |
Die Prinzipal-ID der vom Benutzer zugewiesenen Identität. |