Pool class
Klasse, die einen Pool darstellt.
Konstruktoren
| Pool(Batch |
Erstellen sie einen Pool. |
Methoden
| add(Pool |
Vermeiden Sie beim Benennen von Pools vertrauliche Informationen wie Benutzernamen oder geheime Projektnamen. Diese Informationen können in Telemetrieprotokollen angezeigt werden, auf die microsoft-Supporttechniker zugreifen können. |
| add(Pool |
|
| add(Pool |
|
| delete |
Wenn Sie anfordern, dass ein Pool gelöscht wird, treten die folgenden Aktionen auf: Der Poolstatus ist auf das Löschen festgelegt; alle laufenden Größenänderungsvorgänge im Pool werden beendet; Der Batchdienst startet die Größenänderung des Pools auf null Computeknoten; alle Aufgaben, die auf vorhandenen Computeknoten ausgeführt werden, werden beendet und erneut abgefragt (als ob ein Vorgang zur Größenänderung mit der Standardoption für die erneute Warteschlange angefordert wurde); schließlich wird der Pool aus dem System entfernt. Da die Ausführung von Aufgaben erneut abgefragt wird, kann der Benutzer diese Aufgaben erneut ausführen, indem er seinen Auftrag auf einen anderen Pool aktualisiert. Die Aufgaben können dann im neuen Pool ausgeführt werden. Wenn Sie das Verhalten der erneuten Warteschlange außer Kraft setzen möchten, sollten Sie die Größe des Pools explizit aufrufen, um die Größe des Pools auf null zu verkleinern, bevor Sie den Pool löschen. Wenn Sie eine Update-, Patch- oder Delete-API für einen Pool im Löschzustand aufrufen, schlägt sie mit dem HTTP-Statuscode 409 mit dem Fehlercode PoolBeingDeleted fehl. |
| delete |
|
| delete |
|
| disable |
|
| disable |
|
| disable |
|
| enable |
Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Vorgang zum Ändern der Größe im Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Autoskalenformel als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Autoskalenformel und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht für denselben Pool mehr als einmal alle 30 Sekunden aufrufen. |
| enable |
|
| enable |
|
| evaluate |
Diese API dient in erster Linie zum Validieren einer Autoskalenformel, da sie einfach das Ergebnis zurückgibt, ohne die Formel auf den Pool anzuwenden. Der Pool muss die automatische Skalierung aktiviert haben, um eine Formel auszuwerten. |
| evaluate |
|
| evaluate |
|
| exists(string, Pool |
Ruft grundlegende Eigenschaften eines Pools ab. |
| exists(string, Pool |
|
| exists(string, Service |
|
| get(string, Pool |
Ruft Informationen zum angegebenen Pool ab. |
| get(string, Pool |
|
| get(string, Service |
|
| get |
Statistiken werden in allen Pools aggregiert, die je im Konto vorhanden sind, von der Kontoerstellung bis zur letzten Aktualisierungszeit der Statistik. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batchdienst führt regelmäßige Rollups von Statistiken durch. Die typische Verzögerung beträgt ca. 30 Minuten. |
| get |
|
| get |
|
| list(Pool |
|
| list(Pool |
|
| list(Service |
|
| list |
|
| list |
|
| list |
|
| list |
Wenn Sie keine $filter Klausel einschließlich einer poolId angeben, enthält die Antwort alle Pools, die im Konto im Zeitraum der zurückgegebenen Aggregationsintervalle vorhanden sind. Wenn Sie keine $filter Klausel angeben, die eine startTime- oder EndTime-Klausel enthält, werden diese Filter standardmäßig auf die Start- und Endzeiten des letzten verfügbaren Aggregationsintervalls festgelegt. d. h., nur das letzte Aggregationsintervall wird zurückgegeben. |
| list |
|
| list |
|
| list |
Wenn Sie keine $filter Klausel einschließlich einer poolId angeben, enthält die Antwort alle Pools, die im Konto im Zeitraum der zurückgegebenen Aggregationsintervalle vorhanden sind. Wenn Sie keine $filter Klausel angeben, die eine startTime- oder EndTime-Klausel enthält, werden diese Filter standardmäßig auf die Start- und Endzeiten des letzten verfügbaren Aggregationsintervalls festgelegt. d. h., nur das letzte Aggregationsintervall wird zurückgegeben. |
| list |
|
| list |
|
| patch(string, Pool |
Dadurch werden nur die in der Anforderung angegebenen Pooleigenschaften ersetzt. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und eine Anforderung kein StartTask-Element angibt, behält der Pool den vorhandenen StartTask bei. |
| patch(string, Pool |
|
| patch(string, Pool |
|
| remove |
Dieser Vorgang kann nur ausgeführt werden, wenn der Zuordnungsstatus des Pools stabil ist. Wenn dieser Vorgang ausgeführt wird, ändert sich der Zuordnungsstatus von stetig in Größenänderung. |
| remove |
|
| remove |
|
| resize(string, Pool |
Sie können die Größe eines Pools nur ändern, wenn der Zuordnungszustand stabil ist. Wenn die Größe des Pools bereits geändert wird, schlägt die Anforderung mit dem Statuscode 409 fehl. Wenn Sie die Größe eines Pools ändern, ändert sich der Zuordnungsstatus des Pools von stetig zur Größenänderung. Sie können die Größe von Pools, die für die automatische Skalierung konfiguriert sind, nicht ändern. Wenn Sie versuchen, dies zu tun, gibt der Batchdienst einen Fehler 409 zurück. Wenn Sie die Größe eines Pools nach unten ändern, wählt der Batchdienst aus, welche Computeknoten entfernt werden sollen. Verwenden Sie zum Entfernen bestimmter Computeknoten stattdessen die Computeknoten-API des Pools. |
| resize(string, Pool |
|
| resize(string, Pool |
|
| stop |
Dadurch wird der Pool vor dem Vorgang zum Ändern der Größe nicht wiederhergestellt: Er stoppt nur alle weiteren Änderungen, und der Pool behält seinen aktuellen Zustand bei. Nach dem Beenden stabilisiert sich der Pool bei der Anzahl der Computeknoten, bei der der Stoppvorgang durchgeführt wurde. Während des Stoppvorgangs ändert sich der Poolzuordnungsstatus zuerst in den Stopp und dann in beständig. Ein Größenänderungsvorgang muss keine explizite Anforderung zum Ändern der Größe des Pools sein. Diese API kann auch verwendet werden, um die anfängliche Größenanpassung des Pools beim Erstellen anzuhalten. |
| stop |
|
| stop |
|
| update |
Dadurch werden alle aktualisierbaren Eigenschaften des Pools vollständig ersetzt. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und StartTask nicht mit dieser Anforderung angegeben wird, entfernt der Batchdienst den vorhandenen StartTask. |
| update |
|
| update |
Details zum Konstruktor
Pool(BatchServiceClientContext)
Erstellen sie einen Pool.
new Pool(client: BatchServiceClientContext)Parameter
- client
- BatchServiceClientContext
Verweisen auf den Dienstclient.
Details zur Methode
add(PoolAddParameter, PoolAddOptionalParams)
Vermeiden Sie beim Benennen von Pools vertrauliche Informationen wie Benutzernamen oder geheime Projektnamen. Diese Informationen können in Telemetrieprotokollen angezeigt werden, auf die microsoft-Supporttechniker zugreifen können.
function add(pool: PoolAddParameter, options?: PoolAddOptionalParams): Promise<PoolAddResponse>Parameter
- pool
- PoolAddParameter
Der hinzuzufügende Pool.
- options
- PoolAddOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolAddResponse>
Zusage<Models.PoolAddResponse>
add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)
function add(pool: PoolAddParameter, options: PoolAddOptionalParams, callback: ServiceCallback<void>)Parameter
- pool
- PoolAddParameter
Der hinzuzufügende Pool.
- options
- PoolAddOptionalParams
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
add(PoolAddParameter, ServiceCallback<void>)
function add(pool: PoolAddParameter, callback: ServiceCallback<void>)Parameter
- pool
- PoolAddParameter
Der hinzuzufügende Pool.
- callback
-
ServiceCallback<void>
Der Rückruf
deleteMethod(string, PoolDeleteMethodOptionalParams)
Wenn Sie anfordern, dass ein Pool gelöscht wird, treten die folgenden Aktionen auf: Der Poolstatus ist auf das Löschen festgelegt; alle laufenden Größenänderungsvorgänge im Pool werden beendet; Der Batchdienst startet die Größenänderung des Pools auf null Computeknoten; alle Aufgaben, die auf vorhandenen Computeknoten ausgeführt werden, werden beendet und erneut abgefragt (als ob ein Vorgang zur Größenänderung mit der Standardoption für die erneute Warteschlange angefordert wurde); schließlich wird der Pool aus dem System entfernt. Da die Ausführung von Aufgaben erneut abgefragt wird, kann der Benutzer diese Aufgaben erneut ausführen, indem er seinen Auftrag auf einen anderen Pool aktualisiert. Die Aufgaben können dann im neuen Pool ausgeführt werden. Wenn Sie das Verhalten der erneuten Warteschlange außer Kraft setzen möchten, sollten Sie die Größe des Pools explizit aufrufen, um die Größe des Pools auf null zu verkleinern, bevor Sie den Pool löschen. Wenn Sie eine Update-, Patch- oder Delete-API für einen Pool im Löschzustand aufrufen, schlägt sie mit dem HTTP-Statuscode 409 mit dem Fehlercode PoolBeingDeleted fehl.
function deleteMethod(poolId: string, options?: PoolDeleteMethodOptionalParams): Promise<PoolDeleteResponse>Parameter
- poolId
-
string
Die ID des zu löschenden Pools.
- options
- PoolDeleteMethodOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolDeleteResponse>
Zusage<Models.PoolDeleteResponse>
deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(poolId: string, options: PoolDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des zu löschenden Pools.
- options
- PoolDeleteMethodOptionalParams
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(poolId: string, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des zu löschenden Pools.
- callback
-
ServiceCallback<void>
Der Rückruf
disableAutoScale(string, PoolDisableAutoScaleOptionalParams)
function disableAutoScale(poolId: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>Parameter
- poolId
-
string
Die ID des Pools, auf dem die automatische Skalierung deaktiviert werden soll.
Die optionalen Parameter
Gibt zurück
Promise<PoolDisableAutoScaleResponse>
Promise<Models.PoolDisableAutoScaleResponse>
disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)
function disableAutoScale(poolId: string, options: PoolDisableAutoScaleOptionalParams, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, auf dem die automatische Skalierung deaktiviert werden soll.
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
disableAutoScale(string, ServiceCallback<void>)
function disableAutoScale(poolId: string, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, auf dem die automatische Skalierung deaktiviert werden soll.
- callback
-
ServiceCallback<void>
Der Rückruf
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)
Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Vorgang zum Ändern der Größe im Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Autoskalenformel als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Autoskalenformel und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht für denselben Pool mehr als einmal alle 30 Sekunden aufrufen.
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options?: PoolEnableAutoScaleOptionalParams): Promise<PoolEnableAutoScaleResponse>Parameter
- poolId
-
string
Die ID des Pools, auf dem die automatische Skalierung aktiviert werden soll.
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
Die Parameter für die Anforderung.
Die optionalen Parameter
Gibt zurück
Promise<PoolEnableAutoScaleResponse>
Zusage<Models.PoolEnableAutoScaleResponse>
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options: PoolEnableAutoScaleOptionalParams, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, auf dem die automatische Skalierung aktiviert werden soll.
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
Die Parameter für die Anforderung.
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, auf dem die automatische Skalierung aktiviert werden soll.
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
Die Parameter für die Anforderung.
- callback
-
ServiceCallback<void>
Der Rückruf
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)
Diese API dient in erster Linie zum Validieren einer Autoskalenformel, da sie einfach das Ergebnis zurückgibt, ohne die Formel auf den Pool anzuwenden. Der Pool muss die automatische Skalierung aktiviert haben, um eine Formel auszuwerten.
function evaluateAutoScale(poolId: string, autoScaleFormula: string, options?: PoolEvaluateAutoScaleOptionalParams): Promise<PoolEvaluateAutoScaleResponse>Parameter
- poolId
-
string
Die ID des Pools, für den die automatische Skalierungsformel ausgewertet werden soll.
- autoScaleFormula
-
string
Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Die Formel wird überprüft, und die Ergebnisse werden berechnet, aber nicht auf den Pool angewendet. Um die Formel auf den Pool anzuwenden, "Automatische Skalierung für einen Pool aktivieren". Weitere Informationen zum Angeben dieser Formel finden Sie unter Automatisches Skalieren von Computeknoten in einem Azure-Batchpool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
Die optionalen Parameter
Gibt zurück
Promise<PoolEvaluateAutoScaleResponse>
Promise<Models.PoolEvaluateAutoScaleResponse>
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)
function evaluateAutoScale(poolId: string, autoScaleFormula: string, options: PoolEvaluateAutoScaleOptionalParams, callback: ServiceCallback<AutoScaleRun>)Parameter
- poolId
-
string
Die ID des Pools, für den die automatische Skalierungsformel ausgewertet werden soll.
- autoScaleFormula
-
string
Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Die Formel wird überprüft, und die Ergebnisse werden berechnet, aber nicht auf den Pool angewendet. Um die Formel auf den Pool anzuwenden, "Automatische Skalierung für einen Pool aktivieren". Weitere Informationen zum Angeben dieser Formel finden Sie unter Automatisches Skalieren von Computeknoten in einem Azure-Batchpool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
Die optionalen Parameter
- callback
Der Rückruf
evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)
function evaluateAutoScale(poolId: string, autoScaleFormula: string, callback: ServiceCallback<AutoScaleRun>)Parameter
- poolId
-
string
Die ID des Pools, für den die automatische Skalierungsformel ausgewertet werden soll.
- autoScaleFormula
-
string
Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Die Formel wird überprüft, und die Ergebnisse werden berechnet, aber nicht auf den Pool angewendet. Um die Formel auf den Pool anzuwenden, "Automatische Skalierung für einen Pool aktivieren". Weitere Informationen zum Angeben dieser Formel finden Sie unter Automatisches Skalieren von Computeknoten in einem Azure-Batchpool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- callback
Der Rückruf
exists(string, PoolExistsOptionalParams)
Ruft grundlegende Eigenschaften eines Pools ab.
function exists(poolId: string, options?: PoolExistsOptionalParams): Promise<PoolExistsResponse>Parameter
- poolId
-
string
Die ID des abzurufenden Pools.
- options
- PoolExistsOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolExistsResponse>
Zusage<Models.PoolExistsResponse>
exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)
function exists(poolId: string, options: PoolExistsOptionalParams, callback: ServiceCallback<boolean>)Parameter
- poolId
-
string
Die ID des abzurufenden Pools.
- options
- PoolExistsOptionalParams
Die optionalen Parameter
- callback
-
ServiceCallback<boolean>
Der Rückruf
exists(string, ServiceCallback<boolean>)
function exists(poolId: string, callback: ServiceCallback<boolean>)Parameter
- poolId
-
string
Die ID des abzurufenden Pools.
- callback
-
ServiceCallback<boolean>
Der Rückruf
get(string, PoolGetOptionalParams)
Ruft Informationen zum angegebenen Pool ab.
function get(poolId: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>Parameter
- poolId
-
string
Die ID des abzurufenden Pools.
- options
- PoolGetOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolGetResponse>
Zusage<Models.PoolGetResponse>
get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)
function get(poolId: string, options: PoolGetOptionalParams, callback: ServiceCallback<CloudPool>)Parameter
- poolId
-
string
Die ID des abzurufenden Pools.
- options
- PoolGetOptionalParams
Die optionalen Parameter
- callback
Der Rückruf
get(string, ServiceCallback<CloudPool>)
function get(poolId: string, callback: ServiceCallback<CloudPool>)Parameter
- poolId
-
string
Die ID des abzurufenden Pools.
- callback
Der Rückruf
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)
Statistiken werden in allen Pools aggregiert, die je im Konto vorhanden sind, von der Kontoerstellung bis zur letzten Aktualisierungszeit der Statistik. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batchdienst führt regelmäßige Rollups von Statistiken durch. Die typische Verzögerung beträgt ca. 30 Minuten.
function getAllLifetimeStatistics(options?: PoolGetAllLifetimeStatisticsOptionalParams): Promise<PoolGetAllLifetimeStatisticsResponse>Parameter
Die optionalen Parameter
Gibt zurück
Promise<PoolGetAllLifetimeStatisticsResponse>
Promise<Models.PoolGetAllLifetimeStatisticsResponse>
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)
function getAllLifetimeStatistics(options: PoolGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<PoolStatistics>)Parameter
Die optionalen Parameter
- callback
Der Rückruf
getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)
function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)Parameter
- callback
Der Rückruf
list(PoolListOptionalParams)
function list(options?: PoolListOptionalParams): Promise<PoolListResponse>Parameter
- options
- PoolListOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolListResponse>
Zusage<Models.PoolListResponse>
list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)
function list(options: PoolListOptionalParams, callback: ServiceCallback<CloudPoolListResult>)Parameter
- options
- PoolListOptionalParams
Die optionalen Parameter
- callback
Der Rückruf
list(ServiceCallback<CloudPoolListResult>)
function list(callback: ServiceCallback<CloudPoolListResult>)Parameter
- callback
Der Rückruf
listNext(string, PoolListNextOptionalParams)
function listNext(nextPageLink: string, options?: PoolListNextOptionalParams): Promise<PoolListResponse>Parameter
- nextPageLink
-
string
Der NextLink aus dem vorherigen erfolgreichen Aufruf des List-Vorgangs.
- options
- PoolListNextOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolListResponse>
Zusage<Models.PoolListResponse>
listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)
function listNext(nextPageLink: string, options: PoolListNextOptionalParams, callback: ServiceCallback<CloudPoolListResult>)Parameter
- nextPageLink
-
string
Der NextLink aus dem vorherigen erfolgreichen Aufruf des List-Vorgangs.
- options
- PoolListNextOptionalParams
Die optionalen Parameter
- callback
Der Rückruf
listNext(string, ServiceCallback<CloudPoolListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudPoolListResult>)Parameter
- nextPageLink
-
string
Der NextLink aus dem vorherigen erfolgreichen Aufruf des List-Vorgangs.
- callback
Der Rückruf
listUsageMetrics(PoolListUsageMetricsOptionalParams)
Wenn Sie keine $filter Klausel einschließlich einer poolId angeben, enthält die Antwort alle Pools, die im Konto im Zeitraum der zurückgegebenen Aggregationsintervalle vorhanden sind. Wenn Sie keine $filter Klausel angeben, die eine startTime- oder EndTime-Klausel enthält, werden diese Filter standardmäßig auf die Start- und Endzeiten des letzten verfügbaren Aggregationsintervalls festgelegt. d. h., nur das letzte Aggregationsintervall wird zurückgegeben.
function listUsageMetrics(options?: PoolListUsageMetricsOptionalParams): Promise<PoolListUsageMetricsResponse>Parameter
Die optionalen Parameter
Gibt zurück
Promise<PoolListUsageMetricsResponse>
Promise<Models.PoolListUsageMetricsAntwort>
listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetrics(options: PoolListUsageMetricsOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)Parameter
Die optionalen Parameter
- callback
Der Rückruf
listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)Parameter
- callback
Der Rückruf
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)
Wenn Sie keine $filter Klausel einschließlich einer poolId angeben, enthält die Antwort alle Pools, die im Konto im Zeitraum der zurückgegebenen Aggregationsintervalle vorhanden sind. Wenn Sie keine $filter Klausel angeben, die eine startTime- oder EndTime-Klausel enthält, werden diese Filter standardmäßig auf die Start- und Endzeiten des letzten verfügbaren Aggregationsintervalls festgelegt. d. h., nur das letzte Aggregationsintervall wird zurückgegeben.
function listUsageMetricsNext(nextPageLink: string, options?: PoolListUsageMetricsNextOptionalParams): Promise<PoolListUsageMetricsResponse>Parameter
- nextPageLink
-
string
Der NextLink aus dem vorherigen erfolgreichen Aufruf des List-Vorgangs.
Die optionalen Parameter
Gibt zurück
Promise<PoolListUsageMetricsResponse>
Promise<Models.PoolListUsageMetricsAntwort>
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetricsNext(nextPageLink: string, options: PoolListUsageMetricsNextOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)Parameter
- nextPageLink
-
string
Der NextLink aus dem vorherigen erfolgreichen Aufruf des List-Vorgangs.
Die optionalen Parameter
- callback
Der Rückruf
listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetricsNext(nextPageLink: string, callback: ServiceCallback<PoolListUsageMetricsResult>)Parameter
- nextPageLink
-
string
Der NextLink aus dem vorherigen erfolgreichen Aufruf des List-Vorgangs.
- callback
Der Rückruf
patch(string, PoolPatchParameter, PoolPatchOptionalParams)
Dadurch werden nur die in der Anforderung angegebenen Pooleigenschaften ersetzt. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und eine Anforderung kein StartTask-Element angibt, behält der Pool den vorhandenen StartTask bei.
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options?: PoolPatchOptionalParams): Promise<PoolPatchResponse>Parameter
- poolId
-
string
Die ID des zu aktualisierenden Pools.
- poolPatchParameter
- PoolPatchParameter
Die Parameter für die Anforderung.
- options
- PoolPatchOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolPatchResponse>
Promise<Models.PoolPatchResponse>
patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options: PoolPatchOptionalParams, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des zu aktualisierenden Pools.
- poolPatchParameter
- PoolPatchParameter
Die Parameter für die Anforderung.
- options
- PoolPatchOptionalParams
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
patch(string, PoolPatchParameter, ServiceCallback<void>)
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des zu aktualisierenden Pools.
- poolPatchParameter
- PoolPatchParameter
Die Parameter für die Anforderung.
- callback
-
ServiceCallback<void>
Der Rückruf
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)
Dieser Vorgang kann nur ausgeführt werden, wenn der Zuordnungsstatus des Pools stabil ist. Wenn dieser Vorgang ausgeführt wird, ändert sich der Zuordnungsstatus von stetig in Größenänderung.
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options?: PoolRemoveNodesOptionalParams): Promise<PoolRemoveNodesResponse>Parameter
- poolId
-
string
Die ID des Pools, aus dem Sie Computeknoten entfernen möchten.
- nodeRemoveParameter
- NodeRemoveParameter
Die Parameter für die Anforderung.
- options
- PoolRemoveNodesOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolRemoveNodesResponse>
Promise<Models.PoolRemoveNodesResponse>
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options: PoolRemoveNodesOptionalParams, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, aus dem Sie Computeknoten entfernen möchten.
- nodeRemoveParameter
- NodeRemoveParameter
Die Parameter für die Anforderung.
- options
- PoolRemoveNodesOptionalParams
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, aus dem Sie Computeknoten entfernen möchten.
- nodeRemoveParameter
- NodeRemoveParameter
Die Parameter für die Anforderung.
- callback
-
ServiceCallback<void>
Der Rückruf
resize(string, PoolResizeParameter, PoolResizeOptionalParams)
Sie können die Größe eines Pools nur ändern, wenn der Zuordnungszustand stabil ist. Wenn die Größe des Pools bereits geändert wird, schlägt die Anforderung mit dem Statuscode 409 fehl. Wenn Sie die Größe eines Pools ändern, ändert sich der Zuordnungsstatus des Pools von stetig zur Größenänderung. Sie können die Größe von Pools, die für die automatische Skalierung konfiguriert sind, nicht ändern. Wenn Sie versuchen, dies zu tun, gibt der Batchdienst einen Fehler 409 zurück. Wenn Sie die Größe eines Pools nach unten ändern, wählt der Batchdienst aus, welche Computeknoten entfernt werden sollen. Verwenden Sie zum Entfernen bestimmter Computeknoten stattdessen die Computeknoten-API des Pools.
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options?: PoolResizeOptionalParams): Promise<PoolResizeResponse>Parameter
- poolId
-
string
Die ID des Pools, deren Größe geändert werden soll.
- poolResizeParameter
- PoolResizeParameter
Die Parameter für die Anforderung.
- options
- PoolResizeOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolResizeResponse>
Zusage<Models.PoolResizeResponse>
resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options: PoolResizeOptionalParams, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, deren Größe geändert werden soll.
- poolResizeParameter
- PoolResizeParameter
Die Parameter für die Anforderung.
- options
- PoolResizeOptionalParams
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
resize(string, PoolResizeParameter, ServiceCallback<void>)
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, deren Größe geändert werden soll.
- poolResizeParameter
- PoolResizeParameter
Die Parameter für die Anforderung.
- callback
-
ServiceCallback<void>
Der Rückruf
stopResize(string, PoolStopResizeOptionalParams)
Dadurch wird der Pool vor dem Vorgang zum Ändern der Größe nicht wiederhergestellt: Er stoppt nur alle weiteren Änderungen, und der Pool behält seinen aktuellen Zustand bei. Nach dem Beenden stabilisiert sich der Pool bei der Anzahl der Computeknoten, bei der der Stoppvorgang durchgeführt wurde. Während des Stoppvorgangs ändert sich der Poolzuordnungsstatus zuerst in den Stopp und dann in beständig. Ein Größenänderungsvorgang muss keine explizite Anforderung zum Ändern der Größe des Pools sein. Diese API kann auch verwendet werden, um die anfängliche Größenanpassung des Pools beim Erstellen anzuhalten.
function stopResize(poolId: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>Parameter
- poolId
-
string
Die ID des Pools, dessen Größe Sie beenden möchten.
- options
- PoolStopResizeOptionalParams
Die optionalen Parameter
Gibt zurück
Promise<PoolStopResizeResponse>
Zusage<Models.PoolStopResizeResponse>
stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)
function stopResize(poolId: string, options: PoolStopResizeOptionalParams, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, dessen Größe Sie beenden möchten.
- options
- PoolStopResizeOptionalParams
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
stopResize(string, ServiceCallback<void>)
function stopResize(poolId: string, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des Pools, dessen Größe Sie beenden möchten.
- callback
-
ServiceCallback<void>
Der Rückruf
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)
Dadurch werden alle aktualisierbaren Eigenschaften des Pools vollständig ersetzt. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und StartTask nicht mit dieser Anforderung angegeben wird, entfernt der Batchdienst den vorhandenen StartTask.
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options?: PoolUpdatePropertiesOptionalParams): Promise<PoolUpdatePropertiesResponse>Parameter
- poolId
-
string
Die ID des zu aktualisierenden Pools.
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
Die Parameter für die Anforderung.
Die optionalen Parameter
Gibt zurück
Promise<PoolUpdatePropertiesResponse>
Promise<Models.PoolUpdatePropertiesResponse>
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options: PoolUpdatePropertiesOptionalParams, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des zu aktualisierenden Pools.
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
Die Parameter für die Anforderung.
Die optionalen Parameter
- callback
-
ServiceCallback<void>
Der Rückruf
updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, callback: ServiceCallback<void>)Parameter
- poolId
-
string
Die ID des zu aktualisierenden Pools.
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
Die Parameter für die Anforderung.
- callback
-
ServiceCallback<void>
Der Rückruf