Certificate - List

Referensi

Layanan:: Batch Service

Versi API:: 2024-07-01.20.0

Mencantumkan semua Sertifikat yang telah ditambahkan ke Akun yang ditentukan.
Peringatan: Operasi ini tidak digunakan lagi dan akan dihapus setelah Februari 2024. Gunakan Ekstensi Azure KeyVault sebagai gantinya.

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
batchUrl	path	True	string	URL dasar untuk semua permintaan layanan Azure Batch.
api-version	query	True	string	Versi API Klien.
$filter	query		string	Klausa $filter OData. Untuk informasi selengkapnya tentang membuat filter ini, lihat https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	Klausa $select OData.
maxresults	query		integer int32	Jumlah maksimum item yang akan dikembalikan dalam respons. Maksimal 1000 Sertifikat dapat dikembalikan.
timeout	query		integer int32	Waktu maksimum yang dapat dihabiskan server untuk memproses permintaan, dalam hitung detik. Defaultnya adalah 30 detik. Jika nilainya lebih besar dari 30, default akan digunakan sebagai gantinya.

Header Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
client-request-id		string uuid	Identitas permintaan yang dihasilkan penelepon, dalam bentuk GUID tanpa dekorasi seperti kurung kurawal, misalnya 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Apakah server harus mengembalikan client-request-id dalam respons.
ocp-date		string date-time-rfc1123	Waktu permintaan dikeluarkan. Pustaka klien biasanya mengatur ini ke waktu jam sistem saat ini; atur secara eksplisit jika Anda memanggil REST API secara langsung.

Respons

Nama

Jenis

Deskripsi

200 OK

CertificateListResult

Respons yang berisi daftar Sertifikat.

Header

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

Other Status Codes

Kesalahan dari layanan Batch.

Keamanan

azure_auth

Alur kode autentikasi Microsoft Entra OAuth 2.0

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Authorization

Jenis: apiKey
Dalam: header

Contoh

Certificate list

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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"
          }
        ]
      }
    }
  ]
}

Definisi

Nama	Deskripsi
BatchError	Respons kesalahan diterima dari layanan Azure Batch.
BatchErrorDetail	Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.
Certificate	Sertifikat yang dapat diinstal pada Simpul Komputasi dan dapat digunakan untuk mengautentikasi operasi pada komputer.
CertificateListResult	Hasil daftar Sertifikat di Akun.
CertificateState	Status Sertifikat.
DeleteCertificateError	Kesalahan yang ditemui oleh layanan Batch saat menghapus Sertifikat.
ErrorMessage	Pesan kesalahan diterima dalam respons kesalahan Azure Batch.
NameValuePair	Mewakili pasangan nama-nilai.

BatchError

Respons kesalahan diterima dari layanan Azure Batch.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
message	ErrorMessage	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values	BatchErrorDetail[]	Kumpulan pasangan kunci-nilai yang berisi detail tambahan tentang kesalahan.

BatchErrorDetail

Item informasi tambahan yang disertakan dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
key	string	Pengidentifikasi yang menentukan arti properti Nilai.
value	string	Informasi tambahan yang disertakan dengan respons kesalahan.

Certificate

Sertifikat yang dapat diinstal pada Simpul Komputasi dan dapat digunakan untuk mengautentikasi operasi pada komputer.

Nama	Jenis	Deskripsi
deleteCertificateError	DeleteCertificateError	Kesalahan yang terjadi pada upaya terakhir untuk menghapus Sertifikat ini. Properti ini diatur hanya jika Sertifikat berada dalam status DeleteFailed.
previousState	CertificateState	Status Sertifikat sebelumnya. Properti ini tidak diatur jika Sertifikat dalam status aktif awal.
previousStateTransitionTime	string	Waktu saat Sertifikat memasuki status sebelumnya. Properti ini tidak diatur jika Sertifikat dalam status Aktif awal.
publicData	string	Bagian publik dari Sertifikat sebagai file .cer yang dikodekan base-64.
state	CertificateState	Status Sertifikat saat ini.
stateTransitionTime	string	Waktu saat Sertifikat memasuki statusnya saat ini.
thumbprint	string	Thumbprint X.509 sertifikat. Ini adalah urutan hingga 40 digit hex.
thumbprintAlgorithm	string	Algoritma yang digunakan untuk memperoleh thumbprint.
url	string	URL Sertifikat.

CertificateListResult

Hasil daftar Sertifikat di Akun.

Nama	Jenis	Deskripsi
odata.nextLink	string	URL untuk mendapatkan serangkaian hasil berikutnya.
value	Certificate[]	Daftar Sertifikat.

CertificateState

Status Sertifikat.

Nama	Jenis	Deskripsi
active	string	Sertifikat tersedia untuk digunakan dalam Kumpulan.
deletefailed	string	Pengguna meminta agar Sertifikat dihapus, tetapi ada Kumpulan yang masih memiliki referensi ke Sertifikat, atau masih diinstal pada satu atau beberapa Simpul. (Yang terakhir dapat terjadi jika Sertifikat telah dihapus dari Kumpulan, tetapi Simpul Komputasi belum dimulai ulang. Simpul Komputasi merefresh Sertifikat mereka hanya ketika dimulai ulang.) Anda dapat menggunakan operasi batalkan penghapusan Sertifikat untuk membatalkan penghapusan, atau operasi hapus Sertifikat untuk mencoba kembali penghapusan.
deleting	string	Pengguna telah meminta agar Sertifikat dihapus, tetapi operasi penghapusan belum selesai. Anda mungkin tidak mereferensikan Sertifikat saat membuat atau memperbarui Kumpulan.

DeleteCertificateError

Kesalahan yang ditemui oleh layanan Batch saat menghapus Sertifikat.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan penghapusan Sertifikat. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
message	string	Pesan yang menjelaskan kesalahan penghapusan Sertifikat, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
values	NameValuePair[]	Daftar detail kesalahan tambahan yang terkait dengan kesalahan penghapusan Sertifikat. Daftar ini mencakup detail seperti Kumpulan aktif dan Simpul Komputasi yang merujuk Sertifikat ini. Namun, jika sejumlah besar sumber daya mereferensikan Sertifikat, daftar hanya berisi sekitar seratus pertama.

ErrorMessage

Pesan kesalahan diterima dalam respons kesalahan Azure Batch.

Nama	Jenis	Deskripsi
lang	string	Kode bahasa pesan kesalahan
value	string	Teks pesan.

NameValuePair

Mewakili pasangan nama-nilai.

Nama	Jenis	Deskripsi
name	string	Nama dalam pasangan nama-nilai.
value	string	Nilai dalam pasangan nama-nilai.