Mengelola profil versi API di Azure Stack Hub

  • Artikel

Profil API menentukan penyedia sumber daya Azure dan versi API untuk titik akhir Azure REST. Anda dapat membuat klien kustom dalam berbagai bahasa menggunakan profil API. Setiap klien menggunakan profil API untuk menghubungi penyedia sumber daya dan versi API yang benar untuk Azure Stack Hub.

Anda dapat membuat aplikasi untuk bekerja dengan penyedia sumber daya Azure tanpa harus tahu persis versi mana dari setiap API penyedia sumber daya yang kompatibel dengan Azure Stack Hub. Cukup ratakan aplikasi Anda ke profil dan SDK kembali ke versi API yang benar.

Topik ini membantu Anda:

  • Memahami profil API untuk Azure Stack Hub.
  • Pelajari cara menggunakan profil API untuk mengembangkan solusi Anda.
  • Lihat tempat menemukan panduan khusus kode.

Ringkasan profil API

  • Profil API digunakan untuk mewakili sekumpulan penyedia sumber daya Azure dan versi API mereka.
  • Profil API dibuat untuk Anda membuat template di beberapa cloud Azure. Profil menyediakan antarmuka yang kompatibel dan stabil.
  • Profil dirilis empat kali setahun.
  • Tiga konvensi penamaan profil digunakan:
    • terbaru
      Berisi versi API terbaru yang dirilis di Azure global.
    • yyyy-mm-dd-hybrid
      Dirilis dua tahunan, rilis ini berfokus pada konsistensi dan stabilitas di beberapa cloud. Profil ini menargetkan kompatibilitas Azure Stack Hub yang optimal.
    • yyyy-mm-dd-profile
      Menyeimbangkan stabilitas optimal dan fitur terbaru.

Profil Azure API dan Kompatibilitas Azure Stack Hub

Profil Azure API terbaru tidak kompatibel dengan Azure Stack Hub. Gunakan konvensi penamaan berikut untuk mengidentifikasi profil mana yang akan digunakan untuk solusi Azure Stack Hub Anda:

terbaru
Profil ini memiliki versi API terbaru yang ditemukan di Azure global, yang tidak berfungsi di Azure Stack Hub. terbaru memiliki jumlah perubahan mencolok yang terbesar. Profil mengesampingkan stabilitas dan kompatibilitas dengan cloud lainnya. Jika Anda mencoba menggunakan versi API terbaru, yang terbaru adalah profil yang harus Anda gunakan.

Yyyy-mm-dd-hybrid
Profil ini dirilis pada bulan Maret dan September setiap tahun. Ini memiliki stabilitas dan kompatibilitas optimal dengan berbagai cloud, dan dirancang untuk menargetkan Azure global dan Azure Stack Hub. Versi Azure API yang tercantum dalam profil ini akan sama dengan yang tercantum di Azure Stack Hub. Gunakan profil ini untuk mengembangkan kode untuk solusi cloud hybrid.

yyyy-mm-dd-profile
Profil ini dirilis untuk Azure global pada bulan Juni dan Desember. Ini tidak bekerja dengan Azure Stack Hub, dan biasanya akan ada banyak perubahan yang mencolok. Meskipun profil ini menyeimbangkan stabilitas optimal dan fitur terbaru, perbedaan antara profil terbaru dan profil ini adalah bahwa terbaru selalu terdiri dari versi API terbaru, terlepas dari kapan API dirilis. Misalnya, jika versi API baru dibuat untuk Compute API besok, versi API tersebut tercantum dalam profil terbaru, tetapi tidak dalam profil yyyy-mm-dd-profile, karena profil ini sudah ada. yyyy-mm-dd-profile mencakup versi terbaru yang dirilis sebelum Juni atau sebelum Desember.

Profil API Azure Resource Manager

Azure Stack Hub tidak menggunakan versi terbaru dari versi API yang ditemukan di Azure global. Saat Anda membuat solusi, Anda harus menemukan versi API untuk setiap penyedia sumber daya Azure yang kompatibel dengan Azure Stack Hub.

Alih-alih meneliti setiap penyedia sumber daya dan versi spesifik yang didukung oleh Azure Stack Hub, Anda dapat menggunakan profil API. Profil menentukan sekumpulan penyedia sumber daya dan versi API. SDK, atau alat yang dibuat dengan SDK, akan kembali ke target api-version yang ditentukan dalam profil. Dengan profil API, Anda dapat menentukan versi profil yang berlaku untuk seluruh template. Saat runtime, Azure Resource Manager memilih versi sumber daya yang tepat.

Profil API bekerja dengan alat yang menggunakan Azure Resource Manager, seperti PowerShell, Azure CLI, kode yang disediakan dalam SDK, dan Microsoft Visual Studio. Alat dan SDK dapat menggunakan profil untuk membaca versi modul dan pustaka mana yang akan disertakan saat membangun aplikasi.

Misalnya, jika Anda menggunakan PowerShell untuk membuat akun penyimpanan menggunakan penyedia sumber daya Microsoft.Storage, yang mendukung api-version 2016-03-30 dan VM menggunakan penyedia sumber daya Microsoft.Compute dengan api-version 2015-12-01, Anda harus mencari modul PowerShell mana yang mendukung 2016-03-30 untuk Storage, dan modul mana yang mendukung 2015-02-01 untuk Compute, lalu menginstalnya. Sebagai gantinya, Anda dapat menggunakan profil. Gunakan cmdlet Install-Profile <profilename>, dan PowerShell akan memuat versi modul yang benar.

Demikian pula, saat menggunakan SDK Python untuk membuat aplikasi berbasis Python, Anda dapat menentukan profilnya. SDK memuat modul yang tepat untuk penyedia sumber daya yang telah Anda tentukan dalam skrip Anda.

Sebagai pengembang, artinya Anda dapat fokus untuk menulis solusi Anda. Alih-alih meneliti versi API, penyedia sumber daya, dan cloud mana yang bekerja sama, Anda dapat menggunakan profil dan mengetahui bahwa kode Anda berfungsi di semua cloud yang mendukung profil itu.

Sampel kode profil API

Anda dapat menemukan sampel kode untuk membantu mengintegrasikan solusi dengan bahasa pilihan Anda dengan Azure Stack Hub dengan menggunakan profil. Saat ini, Anda dapat menemukan panduan dan sampel untuk bahasa berikut:

  • .NET
    Gunakan profil .NET API untuk mendapatkan versi terbaru dan paling stabil dari setiap jenis sumber daya dalam paket penyedia sumber daya. Untuk informasi selengkapnya, lihat Menggunakan profil versi API dengan .NET di Azure Stack Hub.
  • PowerShell
    Modul Az.Bootstrapper yang tersedia melalui Galeri PowerShell menyediakan cmdlet PowerShell yang diperlukan untuk bekerja dengan profil versi API. Untuk informasi, lihat Menggunakan profil versi API untuk PowerShell. Gunakan modul AzureRM.Bootstrapper yang tersedia melalui Galeri PowerShell untuk mendapatkan cmdlets PowerShell yang diperlukan untuk bekerja dengan profil versi API. Untuk informasi, lihat Menggunakan profil versi API untuk PowerShell.
  • Azure CLI
    Perbarui konfigurasi lingkungan Anda untuk menggunakan profil versi API khusus Azure Stack Hub. Untuk informasi, lihat Menggunakan profil versi API untuk Azure CLI.
  • Go
    Di Go SDK, profil adalah kombinasi dari jenis sumber daya yang berbeda dengan versi yang berbeda dari layanan yang berbeda. Profil tersedia pada profil/jalur dengan versi mereka dalam format YYYY-MM-DD. Untuk informasi, lihat Menggunakan profil versi API untuk Go.
  • Ruby
    Ruby SDK untuk Azure Stack Hub Resource Manager menyediakan alat untuk membantu Anda membangun dan mengelola infrastruktur Anda. Penyedia sumber daya dalam SDK termasuk komputasi, jaringan virtual, dan penyimpanan dengan bahasa Ruby. Untuk informasi, lihat Menggunakan profil versi API dengan Ruby.
  • Python
    Python SDK mendukung profil versi API untuk menargetkan platform cloud yang berbeda, seperti Azure Stack Hub dan Azure global. Gunakan profil API untuk membuat solusi untuk cloud hybrid. Untuk informasi, lihat Menggunakan profil versi API untuk Phyton.
  • Node.js
    SDK Node.js untuk Azure Stack Hub Resource Manager menyediakan alat untuk membantu Anda membangun dan mengelola infrastruktur Anda. Untuk informasi, lihat Menggunakan profil versi API untuk Node.js.

Langkah berikutnya