Cloud Services - List All
取得訂用帳戶中所有雲端服務的清單,不論相關聯的資源群組為何。 在回應中使用 nextLink 屬性,以取得下一頁的 雲端服務。 請執行此動作,直到 nextLink 為 null,以擷取所有 雲端服務。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/cloudServices?api-version=2022-09-04
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
錯誤 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
List Cloud Services in a Subscription
Sample Request
GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/cloudServices?api-version=2022-09-04
Sample Response
{
"value": [
{
"name": "{cs-name}",
"id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
"type": "Microsoft.Compute/cloudServices",
"location": "eastus2euap",
"properties": {
"configuration": "{ServiceConfiguration}",
"upgradeMode": "Auto",
"roleProfile": {
"roles": [
{
"name": "ContosoFrontend",
"sku": {
"name": "Standard_D1_v2",
"tier": "Standard",
"capacity": 2
}
},
{
"name": "ContosoBackend",
"sku": {
"name": "Standard_D1_v2",
"tier": "Standard",
"capacity": 2
}
}
]
},
"osProfile": {
"secrets": []
},
"networkProfile": {
"loadBalancerConfigurations": [
{
"name": "contosolb",
"properties": {
"frontendIpConfigurations": [
{
"name": "contosofe",
"properties": {
"publicIPAddress": {
"id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
}
}
}
]
}
}
]
},
"extensionProfile": {
"extensions": [
{
"name": "RDPExtension",
"properties": {
"autoUpgradeMinorVersion": false,
"provisioningState": "Succeeded",
"rolesAppliedTo": [
"*"
],
"publisher": "Microsoft.Windows.Azure.Extensions",
"type": "RDP",
"typeHandlerVersion": "1.2",
"settings": "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>"
}
}
]
},
"provisioningState": "Succeeded",
"uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
}
}
]
}
定義
名稱 | Description |
---|---|
Api |
Api 錯誤。 |
Api |
Api 錯誤基底。 |
Cloud |
計算服務的錯誤回應。 |
Cloud |
描述雲端服務。 |
Cloud |
描述雲端服務擴充功能配置檔。 |
Cloud |
延伸模組屬性。 |
Cloud |
清單作業結果。 |
Cloud |
雲端服務的網路配置檔。 |
Cloud |
描述雲端服務的 OS 配置檔。 |
Cloud |
雲端服務屬性 |
Cloud |
描述雲端服務的角色配置檔。 |
Cloud |
描述角色屬性。 |
Cloud |
描述雲端服務角色 SKU。 |
Cloud |
雲端服務的位置類型。
可能的值為 |
Cloud |
雲端服務的更新模式。 部署服務時,會將角色執行個體配置給更新網域。 您可以手動起始更新每個更新網域,或自動起始更新所有更新網域。
可能的值為 |
Cloud |
延伸模組的受保護設定,使用 KeyVault 進行加密,再傳送至角色實例。 |
Cloud |
描述 金鑰保存庫 中的單一憑證參考,以及憑證應該位於角色實例上的位置。 |
Cloud |
描述一組相同 金鑰保存庫 的憑證。 |
Extension |
描述雲端服務延伸模組。 |
Inner |
內部錯誤詳細數據。 |
Load |
描述負載平衡器組態。 |
Load |
描述負載平衡器組態的屬性。 |
Load |
指定要用於負載平衡器的前端IP。 僅支援 IPv4 前端 IP 位址。 每個負載平衡器組態都必須有一個前端IP組態。 |
Load |
描述雲端服務IP組態 |
Sub |
|
System |
與此資源相關的系統元數據。 |
ApiError
Api 錯誤。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
details |
API 錯誤詳細數據 |
|
innererror |
Api 內部錯誤 |
|
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
ApiErrorBase
Api 錯誤基底。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
CloudError
計算服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
Api 錯誤。 |
CloudService
描述雲端服務。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼。 |
location |
string |
資源位置。 |
name |
string |
資源名稱。 |
properties |
雲端服務屬性 |
|
systemData |
與此資源相關的系統元數據。 |
|
tags |
object |
資源標籤。 |
type |
string |
資源類型。 |
zones |
string[] |
資源的邏輯可用性區域清單。 清單應該只包含應該布建雲端服務的1個區域。 這是選擇性欄位。 |
CloudServiceExtensionProfile
描述雲端服務擴充功能配置檔。
名稱 | 類型 | Description |
---|---|---|
extensions |
雲端服務的擴充功能清單。 |
CloudServiceExtensionProperties
延伸模組屬性。
名稱 | 類型 | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
明確指定當平臺可供使用時,平臺是否可以自動將 typeHandlerVersion 升級至較高的次要版本。 |
forceUpdateTag |
string |
要強制套用提供的公用和受保護設定的標籤。 變更標籤值可讓您重新執行延伸模組,而不需變更任何公用或受保護的設定。 如果未變更 forceUpdateTag,處理程式仍會套用公用或受保護設定的更新。 如果 forceUpdateTag 和任何公用或受保護的設定都未變更,擴充功能會流向具有相同序號的角色實例,而且處理程式實作是否要重新執行 |
protectedSettings |
object |
在傳送至角色實例之前加密之延伸模組的受保護設定。 |
protectedSettingsFromKeyVault |
延伸模組的受保護設定,使用 KeyVault 進行加密,再傳送至角色實例。 |
|
provisioningState |
string |
布建狀態,只會出現在回應中。 |
publisher |
string |
擴充處理程序發行者的名稱。 |
rolesAppliedTo |
string[] |
要套用此擴充功能的選擇性角色清單。 如果未指定 屬性或指定 『*』,擴充功能會套用至雲端服務中的所有角色。 |
settings |
object |
擴充功能的公用設定。 針對 JSON 延伸模組,這是擴充功能的 JSON 設定。 對於 RDP) 之類的 XML 延伸模組 (,這是延伸模組的 XML 設定。 |
type |
string |
指定擴充功能的類型。 |
typeHandlerVersion |
string |
指定擴充功能的版本。 指定擴充功能的版本。 如果未指定這個專案,或是使用星號 (*) 作為值,則會使用最新版本的延伸模組。 如果以主要版本號碼和星號指定值作為次要版本號碼, (X.) ,則會選取指定主要版本的最新次要版本。 如果 (X.Y) 指定主要版本號碼和次要版本號碼,則會選取特定的擴充功能版本。 如果指定某個版本,則會針對角色執行個體執行自動升級。 |
CloudServiceListResult
清單作業結果。
名稱 | 類型 | Description |
---|---|---|
nextLink |
string |
要擷取下一頁資源的 URI。 使用此專案來取得下一頁的資源。 請執行此動作,直到 nextLink 為 Null,才能擷取所有資源。 |
value |
資源清單。 |
CloudServiceNetworkProfile
雲端服務的網路配置檔。
名稱 | 類型 | Description |
---|---|---|
loadBalancerConfigurations |
負載平衡器組態的清單。 雲端服務最多可以有兩個負載平衡器組態,對應至公用 Load Balancer 和內部 Load Balancer。 |
|
slotType |
雲端服務的位置類型。
可能的值為 |
|
swappableCloudService |
雲端服務的標識碼參考,其中包含主體雲端服務可執行交換的目標IP。 一旦設定此屬性,就無法更新此屬性。 此標識碼所參考的可交換雲端服務必須存在,否則將會擲回錯誤。 |
CloudServiceOsProfile
描述雲端服務的 OS 配置檔。
名稱 | 類型 | Description |
---|---|---|
secrets |
指定應該安裝在角色實例上的憑證集。 |
CloudServiceProperties
雲端服務屬性
名稱 | 類型 | Description |
---|---|---|
allowModelOverride |
boolean |
(選擇性) 指出角色 sku 屬性是否 (roleProfile.roles.sku) 模型/範本中指定的角色實例計數和 .csdef 中分別指定的角色實例計數和 vm 大小。
預設值是 |
configuration |
string |
指定雲端服務的 XML 服務組態 (.cscfg) 。 |
configurationUrl |
string |
指定參考 Blob 服務中服務組態位置的 URL。 服務套件 URL 可以是來自任何記憶體帳戶的共用存取簽章 (SAS) URI。 這是唯寫屬性,而且不會在 GET 呼叫中傳回。 |
extensionProfile |
描述雲端服務擴充功能配置檔。 |
|
networkProfile |
雲端服務的網路配置檔。 |
|
osProfile |
描述雲端服務的 OS 配置檔。 |
|
packageUrl |
string |
指定 URL 以表示服務封裝在 Blob 服務中的位置。 服務套件 URL 可以是來自任何記憶體帳戶的共用存取簽章 (SAS) URI。 這是唯寫屬性,而且不會在 GET 呼叫中傳回。 |
provisioningState |
string |
布建狀態,只會出現在回應中。 |
roleProfile |
描述雲端服務的角色配置檔。 |
|
startCloudService |
boolean |
(選擇性) 指出是否要在建立雲端服務之後立即啟動雲端服務。 預設值是 |
uniqueId |
string |
雲端服務的唯一標識符。 |
upgradeMode |
雲端服務的更新模式。 部署服務時,會將角色執行個體配置給更新網域。 您可以手動起始更新每個更新網域,或自動起始更新所有更新網域。
可能的值為 |
CloudServiceRoleProfile
描述雲端服務的角色配置檔。
名稱 | 類型 | Description |
---|---|---|
roles |
雲端服務的角色清單。 |
CloudServiceRoleProfileProperties
描述角色屬性。
名稱 | 類型 | Description |
---|---|---|
name |
string |
資源名稱。 |
sku |
描述雲端服務角色 SKU。 |
CloudServiceRoleSku
描述雲端服務角色 SKU。
名稱 | 類型 | Description |
---|---|---|
capacity |
integer |
指定雲端服務中的角色實例數目。 |
name |
string |
SKU 名稱。 注意:如果雲端服務目前所在的硬體不支援新的 SKU,您需要刪除並重新建立雲端服務,或返回舊的 SKU。 |
tier |
string |
指定雲端服務的層級。 可能的值為 |
CloudServiceSlotType
雲端服務的位置類型。
可能的值為
生產
預備
如果未指定,預設值為 Production。
名稱 | 類型 | Description |
---|---|---|
Production |
string |
|
Staging |
string |
CloudServiceUpgradeMode
雲端服務的更新模式。 部署服務時,會將角色執行個體配置給更新網域。 您可以手動起始更新每個更新網域,或自動起始更新所有更新網域。
可能的值為
Auto
手動
同時
如果未指定,預設值為 Auto。如果設定為 [手動],則必須呼叫 PUT UpdateDomain 以套用更新。 如果設定為 [自動],則會依序自動套用更新至每個更新網域。
名稱 | 類型 | Description |
---|---|---|
Auto |
string |
|
Manual |
string |
|
Simultaneous |
string |
CloudServiceVaultAndSecretReference
延伸模組的受保護設定,使用 KeyVault 進行加密,再傳送至角色實例。
名稱 | 類型 | Description |
---|---|---|
secretUrl |
string |
包含延伸模組受保護設定的秘密 URL |
sourceVault |
金鑰保存庫的 ARM 資源識別碼 |
CloudServiceVaultCertificate
描述 金鑰保存庫 中的單一憑證參考,以及憑證應該位於角色實例上的位置。
名稱 | 類型 | Description |
---|---|---|
certificateUrl |
string |
這是已上傳至 金鑰保存庫 做為秘密的憑證 URL。 |
CloudServiceVaultSecretGroup
描述一組相同 金鑰保存庫 的憑證。
名稱 | 類型 | Description |
---|---|---|
sourceVault |
包含 VaultCertificates 中所有憑證之 金鑰保存庫 的相對 URL。 |
|
vaultCertificates |
SourceVault 中包含憑證的金鑰保存庫參考清單。 |
Extension
描述雲端服務延伸模組。
名稱 | 類型 | Description |
---|---|---|
name |
string |
延伸模組的名稱。 |
properties |
延伸模組屬性。 |
InnerError
內部錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
errordetail |
string |
內部錯誤訊息或例外狀況傾印。 |
exceptiontype |
string |
例外狀況型別。 |
LoadBalancerConfiguration
描述負載平衡器組態。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
name |
string |
負載平衡器的名稱 |
properties |
負載平衡器組態的屬性。 |
LoadBalancerConfigurationProperties
描述負載平衡器組態的屬性。
名稱 | 類型 | Description |
---|---|---|
frontendIpConfigurations |
指定要用於負載平衡器的前端IP。 僅支援 IPv4 前端 IP 位址。 每個負載平衡器組態都必須有一個前端IP組態。 |
LoadBalancerFrontendIpConfiguration
指定要用於負載平衡器的前端IP。 僅支援 IPv4 前端 IP 位址。 每個負載平衡器組態都必須有一個前端IP組態。
名稱 | 類型 | Description |
---|---|---|
name |
string |
負載平衡器所使用的前端IP組態集合內唯一的資源名稱。 此名稱可用來存取資源。 |
properties |
負載平衡器前端IP組態的屬性。 |
LoadBalancerFrontendIpConfigurationProperties
描述雲端服務IP組態
名稱 | 類型 | Description |
---|---|---|
privateIPAddress |
string |
IP 組態的虛擬網路專用IP位址。 |
publicIPAddress |
公用IP位址資源的參考。 |
|
subnet |
虛擬網路子網資源的參考。 |
SubResource
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
SystemData
與此資源相關的系統元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
指定建立雲端服務 (擴充支援) 資源的 UTC 時間。 |
lastModifiedAt |
string |
指定上次修改雲端服務 (擴充支援) 資源的 UTC 時間。 |