Bagikan melalui

Referensi CLI Lingkungan Penyebaran Azure

Artikel ini menjelaskan perintah yang tersedia untuk membangun gambar kustom menggunakan gambar dasar Azure Deployment Environment (ADE).

Dengan menggunakan ADE CLI, Anda dapat berinteraksi dengan informasi tentang lingkungan Anda dan definisi lingkungan yang ditentukan, mengunggah, dan mengakses file yang diunggah sebelumnya yang terkait dengan lingkungan, merekam lebih banyak pengelogan mengenai operasi eksekusinya, dan mengunggah dan mengakses output penyebaran lingkungan.

Perintah apa yang dapat saya gunakan?

ADE CLI saat ini mendukung perintah berikut:

Informasi tambahan tentang cara memanggil perintah ADE CLI dapat ditemukan dalam dokumentasi yang ditautkan.

set perintah definisi ade

Perintah ini ade definitions memungkinkan pengguna untuk melihat informasi yang terkait dengan definisi yang dipilih untuk lingkungan yang sedang dioperasikan, dan mengunduh file terkait, seperti templat Infrastructure-as-Code (IaC) utama dan tertaut, ke lokasi file tertentu.

Perintah berikut berada dalam set perintah ini:

daftar definisi ade

Perintah daftar dipanggil sebagai berikut:

definitionValue=$(ade definitions list)

Perintah ini mengembalikan objek data yang menjelaskan berbagai properti definisi lingkungan.

Tipe pengembalian

Perintah ini mengembalikan objek JSON yang menjelaskan definisi lingkungan. Berikut adalah contoh objek pengembalian, berdasarkan salah satu definisi lingkungan sampel kami:

{
    "id": "/projects/PROJECT_NAME/catalogs/CATALOG_NAME/environmentDefinitions/appconfig",
    "name": "AppConfig",
    "catalogName": "CATALOG_NAME",
    "description": "Deploys an App Config.",
    "parameters": [
        {
            "id": "name",
            "name": "name",
            "description": "Name of the App Config",
            "type": "string",
            "readOnly": false,
            "required": true,
            "allowed": []
        },
        {
            "id": "location",
            "name": "location",
            "description": "Location to deploy the environment resources",
            "default": "westus3",
            "type": "string",
            "readOnly": false,
            "required": false,
            "allowed": []
        }
    ],
    "parametersSchema": "{\"type\":\"object\",\"properties\":{\"name\":{\"title\":\"name\",\"description\":\"Name of the App Config\"},\"location\":{\"title\":\"location\",\"description\":\"Location to deploy the environment resources\",\"default\":\"westus3\"}},\"required\":[\"name\"]}",
    "templatePath": "CATALOG_NAME/AppConfig/appconfig.bicep",
    "contentSourcePath": "CATALOG_NAME/AppConfig"
}

Memanfaatkan nilai properti yang dikembalikan

Anda dapat menetapkan variabel lingkungan ke properti tertentu dari objek JSON definisi yang dikembalikan dengan menggunakan pustaka JQ (telah diinstal sebelumnya pada gambar yang ditulis ADE), menggunakan format berikut:
environment_name=$(echo $definitionValue | jq -r ".Name")

Anda dapat mempelajari selengkapnya tentang pemfilteran tingkat lanjut dan penggunaan lain untuk pustaka JQ di sini.

unduhan definisi ade

Perintah ini dipanggil sebagai berikut:
ade definitions download --folder-path EnvironmentDefinition

Perintah ini mengunduh templat Infrastructure-as-Code (IaC) utama dan tertaut dan file terkait lainnya dengan templat yang disediakan.

Opsi

--folder-path: Jalur folder untuk mengunduh file definisi lingkungan. Jika tidak ditentukan, perintah menyimpan file dalam folder bernama EnvironmentDefinition pada tingkat direktori saat ini pada waktu eksekusi.

File apa yang dapat saya akses?

Setiap file yang disimpan di atau di bawah tingkat file manifes definisi lingkungan (environment.yaml atau manifest.yaml) dalam repositori katalog dapat diakses saat memanggil perintah ini.

Anda dapat mempelajari selengkapnya tentang mengkurasi definisi lingkungan dan struktur repositori katalog melalui tautan berikut:

Selain itu, file Anda juga akan tersedia dalam kontainer di /ade/repository/{YOUR_CATALOG_NAME}/{RELATIVE_DIRECTORY_TO_MANIFEST}. Misalnya, jika dalam repositori yang Anda sambungkan sebagai katalog Anda, bernama Catalog1, file manifes Anda disimpan di Folder1/Folder2/environment.yaml, file Anda akan ada dalam kontainer di /ade/repository/Catalog1/Folder1/Folder2. ADE menambahkan file-file ini secara otomatis ke lokasi file ini, karena perlu untuk menjalankan penyebaran atau penghapusan Anda dengan sukses.

perintah lingkungan ade

Perintah ini ade environment memungkinkan pengguna untuk melihat informasi yang terkait dengan lingkungan mereka yang sedang dilakukan operasi.

Perintah dipanggil sebagai berikut:

environmentValue=$(ade environment)

Perintah ini mengembalikan objek data yang menjelaskan berbagai properti lingkungan.

Tipe pengembalian

Perintah ini mengembalikan objek JSON yang menjelaskan lingkungan. Berikut adalah contoh objek pengembalian:

{
    "uri": "https://TENANT_ID-DEVCENTER_NAME.DEVCENTER_REGION.devcenter.azure.com/projects/PROJECT_NAME/users/USER_ID/environments/ENVIRONMENT_NAME",
    "name": "ENVIRONMENT_NAME",
    "environmentType": "ENVIRONMENT_TYPE",
    "user": "USER_ID",
    "provisioningState": "PROVISIONING_STATE",
    "resourceGroupId": "/subscriptions/SUBSCRIPTION_ID/resourceGroups/RESOURCE_GROUP_NAME",
    "catalogName": "CATALOG_NAME",
    "environmentDefinitionName": "ENVIRONMENT_DEFINITION_NAME",
    "parameters": {
        "location": "locationInput",
        "name": "nameInput"
    },
    "location": "regionForDeployment"
}

Memanfaatkan nilai properti yang dikembalikan

Anda dapat menetapkan variabel lingkungan ke properti tertentu dari objek JSON definisi yang dikembalikan dengan menggunakan pustaka JQ (telah diinstal sebelumnya pada gambar yang ditulis ADE), menggunakan format berikut:
environment_name=$(echo $environment | jq -r ".Name")

Anda dapat mempelajari selengkapnya tentang pemfilteran tingkat lanjut dan penggunaan lain untuk pustaka JQ di sini.

perintah eksekusi ade

Perintah ade execute digunakan untuk menyediakan pengelogan implisit untuk skrip yang dijalankan di dalam kontainer. Dengan cara ini, output standar atau konten kesalahan standar yang dihasilkan selama perintah dicatat ke file log operasi untuk lingkungan dan dapat diakses menggunakan Azure CLI.

Anda harus menyalurkan semua kesalahan standar dari perintah ini ke file log kesalahan yang ditentukan pada variabel lingkungan $ADE_ERROR_LOG, sehingga detail kesalahan lingkungan mudah diisi dan muncul di portal pengembang.

Opsi

--operation: Input string yang menentukan operasi yang sedang dilakukan dengan perintah . Biasanya, informasi ini disediakan dengan menggunakan variabel lingkungan $ADE_OPERATION_NAME.

--command: Perintah untuk menjalankan dan merekam pengelogan.

Contoh

Perintah ini menjalankan deploy.sh:

ade execute --operation $ADE_OPERATION_NAME --command "./deploy.sh" 2> >(tee -a $ADE_ERROR_LOG)

set perintah file ade

ade files Set perintah memungkinkan pelanggan untuk mengunggah dan mengunduh file dalam kontainer operasi eksekusi untuk lingkungan tertentu yang akan digunakan nanti dalam kontainer, atau dalam eksekusi operasi nanti. Set perintah ini juga digunakan untuk mengunggah file status yang dihasilkan untuk penyedia Infrastructure-as-Code (IaC) tertentu.

Perintah berikut berada dalam set perintah ini:

daftar file ade

Perintah ini mencantumkan file yang tersedia untuk diunduh saat berada dalam kontainer lingkungan.

Tipe pengembalian

Perintah ini mengembalikan file yang tersedia untuk diunduh sebagai array string. Berikut adalah sebuah contoh:

[
    "file1.txt",
    "file2.sh",
    "file3.zip"
]

unduhan file ade

Perintah ini mengunduh file yang dipilih ke lokasi file tertentu dalam kontainer yang dijalankan.

Opsi

--file-name: Nama file yang akan diunduh. Nama file ini harus ada dalam daftar file yang tersedia yang dikembalikan dari ade files list perintah . Opsi ini diperlukan.

--folder-path: Jalur folder untuk mengunduh file ke dalam kontainer. Jalur ini tidak diperlukan, dan CLI secara default mengunduh file ke direktori saat ini saat perintah dijalankan.

--unzip: Atur bendera ini jika Anda ingin mengunduh file zip dari daftar file yang tersedia, dan ingin konten di-unzip ke lokasi folder yang ditentukan.

Contoh

Perintah berikut mengunduh file ke direktori saat ini:

ade files download --file-name file1.txt

Perintah berikut mengunduh file ke folder tingkat bawah berjudul folder1.

ade files download --file-name file1.txt --folder-path folder1

Perintah terakhir mengunduh file zip, dan membuka zip konten file ke direktori saat ini:

ade files download --file-name file3.zip --unzip

unggahan file ade

Perintah ini mengunggah file tunggal yang ditentukan, atau folder zip yang ditentukan sebagai jalur folder ke daftar file yang tersedia untuk diakses lingkungan.

Opsi

--file-path: Jalur tempat file berada dari direktori saat ini untuk diunggah. Opsi ini atau --folder-path opsi ini diperlukan untuk menjalankan perintah ini.

--folder-path: Jalur tempat folder berada dari direktori saat ini untuk diunggah sebagai file zip. File yang dapat diakses yang dihasilkan dapat diakses dengan nama folder terendah. Opsi ini atau --file-path opsi ini diperlukan untuk menjalankan perintah ini.

Petunjuk / Saran

Menentukan file atau folder dengan nama yang sama dengan file yang dapat diakses yang ada untuk lingkungan untuk perintah ini menimpa file yang disimpan sebelumnya (yaitu, jika file1.txt adalah file yang dapat diakses yang ada, mengeksekusi ade files --file-path file1.txt menimpa file yang disimpan sebelumnya).

Contoh

Perintah berikut mengunggah file dari direktori saat ini bernama file1.txt:

ade files upload --file-path "file1.txt"

File ini nantinya dapat diakses dengan menjalankan:

ade files download --file-name "file1.txt"

Perintah berikut mengunggah folder satu tingkat lebih rendah dari direktori saat ini bernama folder1 sebagai file zip bernama folder1.zip:

ade files upload --folder-path "folder1"

Terakhir, perintah berikut mengunggah folder dua tingkat lebih rendah dari direktori saat ini di folder1/folder2 sebagai file zip bernama folder2.zip:

ade files upload --folder-path "folder1/folder2"

perintah ade init

Perintah ade init digunakan untuk menginisialisasi kontainer untuk ADE dengan mengatur variabel lingkungan yang diperlukan dan mengunduh definisi lingkungan yang ditentukan untuk penyebaran. Perintah itu sendiri mencetak perintah shell, yang kemudian dievaluasi dalam titik masuk inti menggunakan perintah berikut:

eval $(ade init)

Anda hanya perlu menjalankan perintah ini sekali. Jika Anda mendasarkan gambar kustom Anda pada salah satu gambar yang ditulis ADE, Anda tidak perlu menjalankan ulang perintah ini.

kumpulan perintah log ade

ade log Perintah digunakan untuk merekam detail mengenai eksekusi operasi pada lingkungan saat berada dalam kontainer. Perintah ini menawarkan banyak tingkat pengelogan yang berbeda, yang kemudian dapat diakses setelah operasi selesai dianalisis, dan pelanggan dapat menentukan file yang berbeda untuk dicatat untuk skenario pengelogan yang berbeda.

ADE mencatat semua pernyataan yang merupakan output ke output standar atau aliran kesalahan standar dalam kontainer. Fitur ini dapat digunakan untuk mengunggah log ke file yang ditentukan pelanggan yang dapat dilihat secara terpisah dari log operasi utama.

Opsi

--content: Input string yang berisi informasi untuk dicatat. Opsi ini diperlukan untuk perintah ini.

--type: Tingkat log (verbose, log, atau kesalahan) untuk mencatat konten di bawah. Jika tidak ditentukan, CLI mencatat konten di tingkat log.

--file: File untuk mencatat konten. Jika tidak ditentukan, CLI mencatat ke file .log yang ditentukan oleh ID Operasi unik dari operasi yang dijalankan.

Contoh

Perintah ini mencatat string ke file log default:

ade log --content "This is a log"

Perintah ini mencatat kesalahan ke file log default:

ade log --type error --content "This is an error."

Perintah ini mencatat string ke file tertentu bernama specialLogFile.txt:

ade log --content "This is a special log." --file "specialLogFile.txt"

perintah hasil operasi ade

Perintah ini ade operation-result memungkinkan detail kesalahan ditambahkan ke lingkungan yang sedang dioperasikan jika operasi gagal, dan memperbarui operasi yang sedang berlangsung.

Perintah dipanggil sebagai berikut:

ade operation-result --code "ExitCode" --message "The operation failed!"

Opsi

--code: String yang merinci kode keluar yang menyebabkan kegagalan operasi

--message: String yang merinci pesan kesalahan untuk kegagalan operasi.

Penting

Operasi ini hanya boleh digunakan tepat sebelum keluar dari kontainer, karena mengatur operasi dalam status Gagal tidak mengizinkan perintah CLI lain berhasil diselesaikan.

set perintah output ade

Perintah ini ade outputs memungkinkan pelanggan mengunggah output dari penyebaran templat Infrastructure-as-Code (IaC) untuk diakses dari API Output untuk ADE.

unggahan output ade

Perintah ini mengunggah konten file JSON yang ditentukan dalam format ADE EnvironmentOutput ke lingkungan, untuk diakses nanti menggunakan API Output untuk ADE.

Opsi

--file: Lokasi file yang berisi objek JSON untuk diunggah.

Contoh

Perintah ini mengunggah file .json bernama outputs.json ke lingkungan untuk berfungsi sebagai output untuk penyebaran yang berhasil:

ade outputs upload --file outputs.json

EnvironmentOutputs Format

Agar, file JSON masuk diserialisasikan dengan benar dan diterima sebagai output penyebaran lingkungan, objek yang dikirimkan harus mengikuti struktur di bawah ini:

{
    "outputs": {
        "output1": {
            "type": "string",
            "value": "This is output 1!",
            "sensitive": false
        },
        "output2": {
            "type": "int",
            "value": 22,
            "sensitive": false
        },
        "output3": {
            "type": "string",
            "value": "This is a sensitive output",
            "sensitive" true
        }
    }
}

Format ini diadaptasi dari bagaimana penyebaran templat ARM melaporkan output penyebaran, bersama dengan properti sensitif. Properti sensitif bersifat opsional, tetapi membatasi tampilan output kepada pengguna dengan akses istimewa, seperti pembuat lingkungan.

Jenis yang dapat diterima untuk output adalah "string", "int", "boolean", "array", dan "object".

Cara mengakses output

Untuk mengakses output baik saat berada dalam kontainer atau pasca-eksekusi, pelanggan dapat menggunakan API Output untuk ADE, dapat diakses baik dengan memanggil titik akhir API atau menggunakan AZ CLI.

Untuk mengakses output dalam kontainer, pelanggan perlu menginstal Azure CLI ke gambar mereka (telah diinstal sebelumnya pada gambar yang ditulis ADE), dan menjalankan perintah berikut:

az login
az devcenter dev environment show-outputs --dev-center-name DEV_CENTER_NAME --project-name PROJECT_NAME --environment-name ENVIRONMENT_NAME

Dukungan

Ajukan masalah.

Dokumentasi tentang ADE

Konten terkait

  • Last updated on