Certificate - List

參考

服務:: Batch Service

API 版本:: 2024-07-01.20.0

列出已新增至指定帳戶的所有憑證。
警告：這項作業已被取代，將在 2024 年 2 月之後移除。請改用 Azure KeyVault 擴充功能。

GET {batchUrl}/certificates?api-version=2024-07-01.20.0

含選擇性參數:

GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
api-version	query	True	string	用戶端 API 版本。
$filter	query		string	OData $filter 子句。如需建構此篩選的詳細資訊，請參閱 https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificates。
$select	query		string	OData $select 子句。
maxresults	query		integer int32	回應中要傳回的項目數目上限。最多可以傳回 1000 個憑證。
timeout	query		integer int32	伺服器可以花費數秒處理要求的時間上限。預設值為30秒。如果值大於 30，則會改用預設值。

要求標頭

Media Types: "application/json; odata=minimalmetadata"

名稱	類型	Description
client-request-id	string uuid	呼叫端產生的要求身分識別，格式為 GUID，不含大括弧，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id	boolean	伺服器是否應該在回應中傳回 client-request-id。
ocp-date	string date-time-rfc1123	發出要求的時間。用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。

回應

名稱	類型	Description
200 OK	CertificateListResult	包含憑證清單的回應。標題 client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服務的錯誤。

名稱

類型

Description

200 OK

CertificateListResult

包含憑證清單的回應。

標題

client-request-id: string
request-id: string
ETag: string
Last-Modified: string

Other Status Codes

BatchError

Batch 服務的錯誤。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

Authorization

類型: apiKey
位於: header

範例

Certificate list

範例要求

HTTP

GET account.region.batch.azure.com/certificates?api-version=2024-07-01.20.0

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "thumbprint": "0123456789abcdef0123456789abcdef01234567",
      "thumbprintAlgorithm": "sha1",
      "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)",
      "state": "deletefailed",
      "stateTransitionTime": "2014-07-31T21:12:58.236Z",
      "previousState": "deleting",
      "previousStateTransitionTime": "2014-07-31T21:11:58.236Z",
      "publicData": "#####...",
      "deleteCertificateError": {
        "code": "PoolsReferencingCertificate",
        "message": "The specified certificate is being used by the below mentioned pool(s)",
        "values": [
          {
            "name": "Pools",
            "value": "mypool1"
          }
        ]
      }
    }
  ]
}

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
Certificate	可在計算節點上安裝的憑證，可用來驗證計算機上的作業。
CertificateListResult	列出帳戶中憑證的結果。
CertificateState	憑證的狀態。
DeleteCertificateError	刪除憑證時 Batch 服務遇到的錯誤。
ErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
NameValuePair	表示名稱/值組。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
message	ErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應隨附的其他資訊。

Certificate

可在計算節點上安裝的憑證，可用來驗證計算機上的作業。

名稱	類型	Description
deleteCertificateError	DeleteCertificateError	上次嘗試刪除此憑證時發生的錯誤。只有當 Certificate 處於 DeleteFailed 狀態時，才會設定此屬性。
previousState	CertificateState	憑證的先前狀態。如果憑證處於初始作用中狀態，則不會設定這個屬性。
previousStateTransitionTime	string	憑證進入其先前狀態的時間。如果憑證處於初始作用中狀態，則不會設定這個屬性。
publicData	string	憑證的公用部分，做為base-64編碼.cer檔案。
state	CertificateState	憑證的目前狀態。
stateTransitionTime	string	憑證進入其目前狀態的時間。
thumbprint	string	憑證的 X.509 指紋。這是最多 40 個十六進位位數的序列。
thumbprintAlgorithm	string	用來衍生指紋的演算法。
url	string	憑證的 URL。

CertificateListResult

列出帳戶中憑證的結果。

名稱	類型	Description
odata.nextLink	string	要取得下一組結果的URL。
value	Certificate[]	憑證清單。

CertificateState

憑證的狀態。

名稱	類型	Description
active	string	憑證可用於集區。
deletefailed	string	使用者要求刪除憑證，但有集區仍具有憑證的參考，或它仍安裝在一或多個節點上。（如果憑證已從集區中移除，但計算節點尚未重新啟動，則會發生後者。只有在節點重新啟動時，計算節點才會重新整理其憑證。您可以使用取消憑證刪除作業來取消刪除，或刪除憑證作業來重試刪除。
deleting	string	使用者已要求刪除憑證，但刪除作業尚未完成。建立或更新集區時，可能不會參考憑證。

DeleteCertificateError

刪除憑證時 Batch 服務遇到的錯誤。

名稱	類型	Description
code	string	憑證刪除錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
message	string	描述憑證刪除錯誤的訊息，其適用於在使用者介面中顯示。
values	NameValuePair[]	與憑證刪除錯誤相關的其他錯誤詳細數據清單。此清單包含參考此憑證的作用中集區和計算節點等詳細數據。不過，如果大量資源參考憑證，清單只會包含大約第一百個。

ErrorMessage

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼
value	string	訊息的文字。

NameValuePair

表示名稱/值組。

名稱	類型	Description
name	string	name-value 配對中的名稱。
value	string	名稱/值組中的值。

共用方式為

Certificate - List

URI 參數

要求標頭

回應

安全性

azure_auth

範圍

Authorization

範例

Certificate list

範例要求

範例回覆

定義

BatchError

BatchErrorDetail

Certificate

CertificateListResult

CertificateState

DeleteCertificateError

ErrorMessage

NameValuePair

其他資源