Objek konteks di Azure PowerShell

Azure PowerShell menggunakan objek konteks Azure PowerShell (konteks Azure) untuk menyimpan informasi langganan dan autentikasi. Jika Anda memiliki akses ke beberapa langganan, konteks Azure memungkinkan Anda memilih langganan untuk menjalankan cmdlet Azure PowerShell. Konteks Azure juga digunakan untuk menyimpan informasi masuk di beberapa sesi PowerShell dan menjalankan tugas latar belakang.

Artikel ini membahas pengelolaan konteks Azure, bukan pengelolaan langganan atau akun. Jika Anda ingin mengelola pengguna, langganan, penyewa, atau informasi akun lainnya, lihat dokumentasi ID Microsoft Entra. Untuk mempelajari tentang menggunakan konteks untuk menjalankan tugas latar belakang atau paralel, lihat Menjalankan cmdlet Azure PowerShell di Pekerjaan PowerShell setelah terbiasa dengan konteks Azure.

Gambaran umum objek konteks Azure

Konteks Azure adalah objek PowerShell yang mewakili langganan aktif Anda untuk menjalankan perintah dan informasi autentikasi yang diperlukan untuk menyambungkan ke cloud Azure. Dengan konteks Azure, Azure PowerShell tidak perlu mengotentikasi ulang akun Anda setiap kali Anda beralih langganan. Konteks Azure terdiri dari:

• Akun yang digunakan untuk masuk ke Azure dengan Connect-AzAccount. Konteks Azure memperlakukan pengguna, ID aplikasi, dan perwakilan layanan sama dari perspektif akun.
• Langganan aktif , yang merupakan perjanjian layanan dengan Microsoft untuk membuat dan menjalankan sumber daya Azure, dan yang terkait dengan penyewa . Penyewa sering disebut sebagai organisasi dalam dokumentasi atau saat bekerja dengan Microsoft Entra.
• Referensi ke cache token , token autentikasi tersimpan untuk mengakses cloud Azure. Pengaturan penyimpanan otomatis konteks menentukan di mana token disimpan dan berapa lama token disimpan.

Untuk informasi selengkapnya tentang istilah-istilah ini, lihat Microsoft Entra Terminology. Token autentikasi yang digunakan oleh konteks Azure sama dengan token tersimpan lainnya yang merupakan bagian dari sesi persisten.

Saat Anda masuk dengan Connect-AzAccount, setidaknya satu konteks Azure dibuat untuk langganan default Anda. Objek yang dikembalikan oleh Connect-AzAccount adalah konteks Azure default yang digunakan untuk sisa sesi PowerShell.

Mengakses konteks Azure

Konteks Azure yang tersedia diambil dengan cmdlet Get-AzContext. Cantumkan konteks yang tersedia dengan parameter ListAvailable:

Get-AzContext -ListAvailable

Atau dapatkan konteks berdasarkan nama:

Get-AzContext -Name MyContextName

Nama konteks mungkin berbeda dari nama langganan terkait. Untuk menentukan nama konteks, gunakan nilai properti Nama, yang tidak ditampilkan secara default.

Get-AzContext -ListAvailable | Select-Object -Property *

Membuat konteks Azure baru dari informasi langganan

Cmdlet Set-AzContext digunakan untuk membuat dan mengatur konteks Azure baru sebagai konteks aktif. Cara term mudah untuk membuat konteks Azure baru adalah dengan menggunakan informasi langganan yang sudah ada. Cmdlet Set-AzContext dirancang untuk mengambil objek output dari Get-AzSubscription sebagai nilai yang dipindahkan melalui pipa dan mengonfigurasi konteks Azure baru.

Get-AzSubscription -SubscriptionName MySubscriptionName |
  Set-AzContext -Name MyContextName

Atau berikan nama langganan atau ID dan ID penyewa jika perlu:

Set-AzContext -Name MyContextName -Subscription MySubscriptionName -Tenant 00000000-0000-0000-0000-000000000000

Jika parameter Nama dihilangkan, maka nama dan ID langganan digunakan sebagai nama konteks dalam format Subscription Name (subscription-id).

Mengubah konteks Azure aktif

Baik Set-AzContext maupun Select-AzContext dapat digunakan untuk mengubah konteks Azure aktif. Seperti yang dijelaskan dalam Membuat konteks Azure baru, Set-AzContext membuat konteks Azure baru untuk langganan jika tidak ada, lalu mengalihkan konteks aktif ke konteks tersebut.

Select-AzContext dimaksudkan untuk digunakan hanya dengan konteks Azure yang ada dan berfungsi sama dengan menggunakan Set-AzContext -Context, tetapi dirancang untuk digunakan dengan pipa:

Set-AzContext -Context (Get-AzContext -Name MyContextName) # Set a context with an inline Azure context object
Get-AzContext -Name MyContextName | Select-AzContext # Set a context with a piped Azure context object

Seperti banyak perintah manajemen akun dan konteks lainnya di Azure PowerShell, Set-AzContext dan Select-AzContext mendukung parameter Cakupan sehingga Anda dapat mengontrol berapa lama konteks aktif. Scope memungkinkan Anda mengubah konteks aktif satu sesi tanpa mengubah default Anda:

Get-AzContext -Name MyContextName | Select-AzContext -Scope Process

Untuk menghindari peralihan konteks untuk seluruh sesi PowerShell, perintah Azure PowerShell dengan parameter AzContext dapat dijalankan terhadap konteks tertentu:

$context = Get-AzContext -Name MyContextName
New-AzVM -Name ExampleVM -AzContext $context

Penggunaan utama konteks lainnya dengan cmdlet Azure PowerShell adalah menjalankan perintah latar belakang. Untuk mempelajari selengkapnya tentang menjalankan Pekerjaan PowerShell menggunakan Azure PowerShell, lihat Menjalankan cmdlet Azure PowerShell di Pekerjaan PowerShell.

Menyimpan konteks Azure di seluruh sesi PowerShell

Secara default, konteks Azure disimpan untuk digunakan di antara sesi PowerShell. Anda dapat mengubah perilaku ini dengan cara berikut:

• Masuk menggunakan -Scope Process dengan Connect-AzAccount.

  Connect-AzAccount -Scope Process
  

  Konteks Azure yang dikembalikan sebagai bagian dari proses masuk ini valid hanya untuk sesi saat ini dan tidak disimpan secara otomatis, terlepas dari apa pun pengaturan penyimpanan otomatis konteks Azure PowerShell.

• Nonaktifkan penyimpanan otomatis konteks di Azure PowerShell dengan cmdlet Disable-AzContextAutosave. Menonaktifkan penyimpanan otomatis konteks tidak menghapus token apa pun yang disimpan. Untuk mempelajari cara menghapus informasi konteks Azure yang disimpan, lihat Menghapus konteks Azure dan kredensial tersimpan.

• Mengaktifkan penyimpanan otomatis konteks Azure secara eksplisit dapat diaktifkan dengan cmdlet Enable-AzContextAutosave. Dengan penyimpanan otomatis diaktifkan, konteks pengguna disimpan secara lokal untuk sesi PowerShell selanjutnya.

• Simpan konteks secara manual dengan Save-AzContext yang akan digunakan dalam sesi PowerShell di masa mendatang, di mana konteks tersebut dapat dimuat dengan Import-AzContext:

  Save-AzContext -Path current-context.json # Save the current context
  Import-AzContext -Path other-context.json # Load the context from a file and set it to the current context
  

Masing-masing perintah ini mendukung parameter Cakupan, yang dapat mengambil nilai Process hanya untuk berlaku pada proses saat ini. Misalnya, untuk memastikan bahwa konteks yang baru dibuat tidak disimpan setelah keluar dari sesi PowerShell:

Disable-AzContextAutosave -Scope Process
Set-AzContext -Subscription 'Subscription ID or Name' -Tenant 00000000-0000-0000-0000-000000000000

Informasi konteks dan token disimpan di direktori $env:USERPROFILE\.Azure di Windows dan $HOME/.Azure di platform lain. Informasi sensitif seperti ID langganan dan ID penyewa mungkin masih diekspos dalam informasi tersimpan, melalui log, atau konteks yang disimpan. Untuk mempelajari cara menghapus informasi tersimpan, lihat Menghapus konteks Azure dan kredensial yang disimpan.

Menghapus konteks Azure dan kredensial tersimpan

Untuk menghapus konteks dan kredensial Azure:

• Keluar dari akun dengan Disconnect-AzAccount. Anda dapat keluar dari akun apa pun baik berdasarkan akun atau konteks:

  Disconnect-AzAccount # Disconnect active account
  Disconnect-AzAccount -Username 'user@contoso.com' # Disconnect by account name
  Disconnect-AzAccount -ContextName MyContextName # Disconnect by context name
  
  $context = Get-AzContext
  Disconnect-AzAccount -AzureContext $context # Disconnect using context object information
  

  Memutuskan sambungan selalu menghapus token autentikasi tersimpan dan menghapus konteks tersimpan yang terkait dengan pengguna atau konteks yang terputus.

• Gunakan Clear-AzContext. Cmdlet ini selalu menghapus konteks tersimpan dan token autentikasi dan membuat Anda keluar.

• Hapus konteks dengan Remove-AzContext:

  Remove-AzContext -Name MyContextName # Remove by name
  Get-AzContext -Name MyContextName | Remove-AzContext # Remove by piping an Azure context object
  

  Jika Anda menghapus konteks aktif, Anda terputus dari Azure dan perlu mengautentikasi ulang dengan Connect-AzAccount.

Lihat juga

• Connect-AzAccount
• Disconnect-AzAccount
• Get-AzContext
• Set-AzContext
• Save-AzContext
• Select-AzContext
• Import-AzContext
• Clear-AzContext
• Remove-AzContext
• Enable-AzContextAutosave
• Disable-AzContextAutosave
• Get-AzSubscription