az healthcareapis service

  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi healthcareapis untuk Azure CLI (versi 2.15.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah layanan az healthcareapis. Pelajari lebih lanjut tentang ekstensi.

Layanan healthcareapis.

Perintah

Nama Deskripsi Jenis Status
az healthcareapis service create

Buat metadata instans layanan.

 Ekstensi GA
az healthcareapis service delete

Menghapus instans layanan.

 Ekstensi GA
az healthcareapis service list

Dapatkan semua instans layanan dalam grup sumber daya. Dan Dapatkan semua instans layanan dalam langganan.

 Ekstensi GA
az healthcareapis service show

Dapatkan metadata instans layanan.

 Ekstensi GA
az healthcareapis service update

Perbarui metadata instans layanan.

 Ekstensi GA
az healthcareapis service wait

Tempatkan CLI dalam keadaan menunggu sampai kondisi layanan layanan kesehatan terpenuhi.

 Ekstensi GA

az healthcareapis service create

Buat metadata instans layanan.

az healthcareapis service create --kind {fhir, fhir-R4, fhir-Stu3}
                                 --location
                                 --resource-group
                                 --resource-name
                                 [--access-policies]
                                 [--authentication-configuration]
                                 [--cors-configuration]
                                 [--cosmos-db-configuration]
                                 [--etag]
                                 [--export-configuration-storage-account-name]
                                 [--identity-type {None, SystemAssigned}]
                                 [--login-servers]
                                 [--no-wait]
                                 [--oci-artifacts]
                                 [--private-endpoint-connections]
                                 [--public-network-access {Disabled, Enabled}]
                                 [--tags]

Contoh

Membuat atau Memperbarui layanan dengan semua parameter

az healthcareapis service create --resource-group "rg1" --resource-name "service1" --identity-type "SystemAssigned" --kind "fhir-R4" --location "westus2" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47" --access-policies object-id="5b307da8-43d4-492b-8b66-b0294ade872f" --authentication-configuration audience="https://azurehealthcareapis.com" authority="https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc" smart-proxy-enabled=true --cors-configuration allow-credentials=false headers="*" max-age=1440 methods="DELETE" methods="GET" methods="OPTIONS" methods="PATCH" methods="POST" methods="PUT" origins="*" --cosmos-db-configuration key-vault-key-uri="https://my-vault.vault.azure.net/keys/my-key" offer-throughput=1000 --export-configuration-storage-account-name "existingStorageAccount" --public-network-access "Disabled"

Membuat atau Memperbarui layanan dengan parameter minimum

az healthcareapis service create --resource-group "rg1" --resource-name "service2" --kind "fhir-R4" --location "westus2" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47"

Parameter yang Diperlukan

--kind

Jenis layanan.

nilai yang diterima: fhir, fhir-R4, fhir-Stu3
--location -l

Lokasi. Nilai dari: az account list-locations. Anda dapat mengonfigurasi lokasi default menggunakan az configure --defaults location=<location>.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--resource-name

Nama instans layanan.

Parameter Opsional

--access-policies

Kebijakan akses instans layanan.

Penggunaan: --access-policies object-id=XX

object-id: Diperlukan. ID objek Azure ACTIVE Directory (Pengguna atau Aplikasi) yang diizinkan mengakses layanan FHIR.

Beberapa tindakan dapat ditentukan dengan menggunakan lebih dari satu argumen --access-policies.

--authentication-configuration -c

Konfigurasi autentikasi untuk instans layanan.

Penggunaan: --authentication-configuration authority=XX audience=XX smart-proxy-enabled=XX

otoritas: Url otoritas untuk audiens layanan: Url audiens untuk layanan yang mendukung proksi pintar: Jika proksi SMART di FHIR diaktifkan.

--cors-configuration

Pengaturan untuk konfigurasi CORS instans layanan.

Penggunaan: --cors-configuration origins=XX headers=XX methods=XX max-age=XX allow-credentials=XX

origins: Asal-usul yang akan diizinkan melalui CORS. header: Header yang akan diizinkan melalui CORS. metode: Metode yang akan diizinkan melalui CORS. max-age: Usia maksimum yang akan diizinkan melalui CORS. allow-credentials: Jika kredensial diizinkan melalui CORS.

--cosmos-db-configuration

Pengaturan untuk database Cosmos DB yang mendukung layanan.

Penggunaan: --cosmos-db-configuration offer-throughput=XX key-vault-key-uri=XX

throughput penawaran: Throughput yang disediakan untuk database cadangan. key-vault-key-uri: URI kunci yang dikelola pelanggan untuk database cadangan.

--etag

Etag yang terkait dengan sumber daya, digunakan untuk konkurensi optimis saat mengeditnya.

--export-configuration-storage-account-name -s

Nama akun penyimpanan ekspor default.

--identity-type

Jenis identitas yang ditentukan, saat ini SystemAssigned dan None diizinkan.

nilai yang diterima: None, SystemAssigned
--login-servers

Daftar server login yang akan ditambahkan ke instans layanan.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--oci-artifacts

Daftar artefak Open Container Initiative (OCI).

Penggunaan: --oci-artifacts login-server=XX image-name=XX digest=XX

login-server: Server masuk Azure Container Registry. image-name: Nama artefak. hash: Hash artefak.

Beberapa tindakan dapat ditentukan dengan menggunakan lebih dari satu argumen --oci-artefak.

--private-endpoint-connections

Daftar koneksi titik akhir privat yang disiapkan untuk sumber daya ini.

Penggunaan: --private-endpoint-connections status=XX description=XX actions-required=XX

status: Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan. deskripsi: Alasan persetujuan/penolakan koneksi. tindakan yang diperlukan: Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan apa pun pada konsumen.

Beberapa tindakan dapat ditentukan dengan menggunakan lebih dari satu argumen --private-endpoint-connections.

--public-network-access

Izin kontrol untuk lalu lintas sarana data yang berasal dari jaringan publik saat titik akhir privat diaktifkan.

nilai yang diterima: Disabled, Enabled
--tags

Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az healthcareapis service delete

Menghapus instans layanan.

az healthcareapis service delete [--ids]
                                 [--no-wait]
                                 [--resource-group]
                                 [--resource-name]
                                 [--subscription]
                                 [--yes]

Contoh

Hapus layanan

az healthcareapis service delete --resource-group "rg1" --resource-name "service1"

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--resource-name

Nama instans layanan.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--yes -y

Jangan meminta konfirmasi.

nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az healthcareapis service list

Dapatkan semua instans layanan dalam grup sumber daya. Dan Dapatkan semua instans layanan dalam langganan.

az healthcareapis service list [--resource-group]

Contoh

Mencantumkan semua layanan dalam grup sumber daya

az healthcareapis service list --resource-group "rgname"

Mencantumkan semua layanan dalam langganan

az healthcareapis service list

Parameter Opsional

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az healthcareapis service show

Dapatkan metadata instans layanan.

az healthcareapis service show [--ids]
                               [--resource-group]
                               [--resource-name]
                               [--subscription]

Contoh

Mendapatkan metadata

az healthcareapis service show --resource-group "rg1" --resource-name "service1"

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--resource-name

Nama instans layanan.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az healthcareapis service update

Perbarui metadata instans layanan.

az healthcareapis service update [--ids]
                                 [--no-wait]
                                 [--public-network-access {Disabled, Enabled}]
                                 [--resource-group]
                                 [--resource-name]
                                 [--subscription]
                                 [--tags]

Contoh

Layanan patch

az healthcareapis service update --resource-group "rg1" --resource-name "service1" --tags tag1="value1" tag2="value2"

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--public-network-access

Izin kontrol untuk lalu lintas sarana data yang berasal dari jaringan publik saat titik akhir privat diaktifkan.

nilai yang diterima: Disabled, Enabled
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--resource-name

Nama instans layanan.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--tags

Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az healthcareapis service wait

Tempatkan CLI dalam keadaan menunggu sampai kondisi layanan layanan kesehatan terpenuhi.

az healthcareapis service wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--resource-group]
                               [--resource-name]
                               [--subscription]
                               [--timeout]
                               [--updated]

Contoh

Jeda menjalankan baris skrip CLI berikutnya hingga layanan healthcareapis berhasil dibuat.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --created

Jeda menjalankan baris skrip CLI berikutnya hingga layanan healthcareapis berhasil diperbarui.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --updated

Jeda menjalankan baris skrip CLI berikutnya hingga layanan healthcareapis berhasil dihapus.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --deleted

Parameter Opsional

--created

Tunggu hingga dibuat dengan 'provisioningState' di 'Berhasil'.

nilai default: False
--custom

Tunggu hingga kondisi memenuhi kueri JMESPath kustom. Misalnya provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Tunggu hingga dihapus.

nilai default: False
--exists

Tunggu hingga sumber daya ada.

nilai default: False
--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--interval

Interval polling dalam hitungan detik.

nilai default: 30
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--resource-name

Nama instans layanan.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--timeout

Tunggu maksimum dalam detik.

nilai default: 3600
--updated

Tunggu hingga diperbarui dengan provisioningState di 'Berhasil'.

nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.