EntitiesListOptionalParams interface

Paket:

@azure/arm-managementgroups

Parameter opsional.

Memperluas

OperationOptions

Properti

cacheControl	Menunjukkan apakah permintaan harus menggunakan cache apa pun. Isi header dengan nilai 'no-cache' untuk melewati cache yang ada.
filter	Parameter filter memungkinkan Anda memfilter bidang nama atau nama tampilan. Anda dapat memeriksa kesetaraan pada bidang nama (misalnya nama eq '{entityName}') dan Anda dapat memeriksa substring pada bidang nama atau nama tampilan (misalnya berisi(nama, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Perhatikan bahwa bidang '{entityName}' dan '{substringToSearch}' diperiksa huruf besar/kecil secara tidak sensitif.
groupName	Filter yang memungkinkan panggilan dapatkan entitas untuk fokus pada grup tertentu (yaitu "$filter=name eq 'groupName'")
search	Parameter $search digunakan bersama dengan parameter $filter untuk mengembalikan tiga output yang berbeda tergantung pada parameter yang diteruskan. Dengan $search=AllowedParents, API akan mengembalikan info entitas dari semua grup yang dapat direparasi oleh entitas yang diminta sebagaimana ditentukan oleh izin pengguna. Dengan $search=AllowedChildren, API akan mengembalikan info entitas dari semua entitas yang dapat ditambahkan sebagai turunan dari entitas yang diminta. Dengan $search=ParentAndFirstLevelChildren, API akan mengembalikan induk dan tingkat pertama anak yang memiliki akses langsung ke atau akses tidak langsung pengguna melalui salah satu turunannya. Dengan $search=ParentOnly, API hanya akan mengembalikan grup jika pengguna memiliki akses ke setidaknya salah satu turunan grup. Dengan $search=ChildrenOnly, API hanya akan mengembalikan tingkat anak pertama dari info entitas grup yang ditentukan dalam $filter. Pengguna harus memiliki akses langsung ke entitas anak atau salah satu turunannya agar muncul dalam hasil.
select	Parameter ini menentukan bidang yang akan disertakan dalam respons. Dapat menyertakan kombinasi Nama,DisplayName,Type,ParentDisplayNameChain,ParentChain, misalnya '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Ketika ditentukan, parameter $select dapat menimpa pilih di $skipToken.
skip	Jumlah entitas yang akan dilewati saat mengambil hasil. Meneruskan ini akan mengambil alih $skipToken.
skiptoken	Token kelanjutan halaman hanya digunakan jika operasi sebelumnya mengembalikan hasil parsial. Jika respons sebelumnya berisi elemen nextLink, nilai elemen nextLink akan menyertakan parameter token yang menentukan titik awal yang akan digunakan untuk panggilan berikutnya.
top	Jumlah elemen yang akan dikembalikan saat mengambil hasil. Meneruskan ini akan mengambil alih $skipToken.
view	Parameter tampilan memungkinkan klien memfilter jenis data yang dikembalikan oleh panggilan getEntities.

Properti yang Diwariskan

abortSignal	Sinyal yang dapat digunakan untuk membatalkan permintaan.
onResponse	Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali.
requestOptions	Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.
serializerOptions	Opsi untuk mengambil alih perilaku serialisasi/de-serialisasi.
tracingOptions	Opsi yang digunakan saat pelacakan diaktifkan.

Detail Properti

cacheControl

Menunjukkan apakah permintaan harus menggunakan cache apa pun. Isi header dengan nilai 'no-cache' untuk melewati cache yang ada.

cacheControl?: string

Nilai Properti

string

filter

Parameter filter memungkinkan Anda memfilter bidang nama atau nama tampilan. Anda dapat memeriksa kesetaraan pada bidang nama (misalnya nama eq '{entityName}') dan Anda dapat memeriksa substring pada bidang nama atau nama tampilan (misalnya berisi(nama, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Perhatikan bahwa bidang '{entityName}' dan '{substringToSearch}' diperiksa huruf besar/kecil secara tidak sensitif.

filter?: string

Nilai Properti

string

groupName

Filter yang memungkinkan panggilan dapatkan entitas untuk fokus pada grup tertentu (yaitu "$filter=name eq 'groupName'")

groupName?: string

Nilai Properti

string

search

Parameter $search digunakan bersama dengan parameter $filter untuk mengembalikan tiga output yang berbeda tergantung pada parameter yang diteruskan. Dengan $search=AllowedParents, API akan mengembalikan info entitas dari semua grup yang dapat direparasi oleh entitas yang diminta sebagaimana ditentukan oleh izin pengguna. Dengan $search=AllowedChildren, API akan mengembalikan info entitas dari semua entitas yang dapat ditambahkan sebagai turunan dari entitas yang diminta. Dengan $search=ParentAndFirstLevelChildren, API akan mengembalikan induk dan tingkat pertama anak yang memiliki akses langsung ke atau akses tidak langsung pengguna melalui salah satu turunannya. Dengan $search=ParentOnly, API hanya akan mengembalikan grup jika pengguna memiliki akses ke setidaknya salah satu turunan grup. Dengan $search=ChildrenOnly, API hanya akan mengembalikan tingkat anak pertama dari info entitas grup yang ditentukan dalam $filter. Pengguna harus memiliki akses langsung ke entitas anak atau salah satu turunannya agar muncul dalam hasil.

search?: string

Nilai Properti

string

select

Parameter ini menentukan bidang yang akan disertakan dalam respons. Dapat menyertakan kombinasi Nama,DisplayName,Type,ParentDisplayNameChain,ParentChain, misalnya '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Ketika ditentukan, parameter $select dapat menimpa pilih di $skipToken.

select?: string

Nilai Properti

string

skip

Jumlah entitas yang akan dilewati saat mengambil hasil. Meneruskan ini akan mengambil alih $skipToken.

skip?: number

Nilai Properti

number

skiptoken

Token kelanjutan halaman hanya digunakan jika operasi sebelumnya mengembalikan hasil parsial. Jika respons sebelumnya berisi elemen nextLink, nilai elemen nextLink akan menyertakan parameter token yang menentukan titik awal yang akan digunakan untuk panggilan berikutnya.

skiptoken?: string

Nilai Properti

string

top

Jumlah elemen yang akan dikembalikan saat mengambil hasil. Meneruskan ini akan mengambil alih $skipToken.

top?: number

Nilai Properti

number

view

Parameter tampilan memungkinkan klien memfilter jenis data yang dikembalikan oleh panggilan getEntities.

view?: string

Nilai Properti

string

Detail Properti yang Diwariskan

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

Diwariskan Dari coreClient.OperationOptions.abortSignal

onResponse

Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali.

onResponse?: RawResponseCallback

Nilai Properti

RawResponseCallback

Diwariskan Dari coreClient.OperationOptions.onResponse

requestOptions

Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.

requestOptions?: OperationRequestOptions

Nilai Properti

OperationRequestOptions

Diwarisi Dari coreClient.OperationOptions.requestOptions

serializerOptions

Opsi untuk mengambil alih perilaku serialisasi/de-serialisasi.

serializerOptions?: SerializerOptions

Nilai Properti

SerializerOptions

Diwariskan Dari coreClient.OperationOptions.serializerOptions

tracingOptions

Opsi yang digunakan saat pelacakan diaktifkan.

tracingOptions?: OperationTracingOptions

Nilai Properti

OperationTracingOptions

Diwariskan Dari coreClient.OperationOptions.tracingOptions