EntitiesListNextOptionalParams interface

Paket:

@azure/arm-managementgroups

İsteğe bağlı parametreler.

Extends

OperationOptions

Özellikler

cacheControl	İsteğin önbellek kullanıp kullanmayacağını gösterir. Mevcut önbellekleri atlamak için üst bilgiyi 'önbellek yok' değeriyle doldurun.
filter	filter parametresi, ad veya görünen ad alanlarını filtrelemenizi sağlar. Ad alanında eşitliği denetleyebilirsiniz (örneğin, eq '{entityName}' adı) ve ad veya görünen ad alanlarında (örn. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')) alt dizeleri de kontrol edebilirsiniz. '{entityName}' ve '{substringToSearch}' alanlarının büyük/küçük harfe duyarsız olarak denetlendiğini unutmayın.
groupName	Get varlıklarının belirli bir gruba odaklanmasını sağlayan bir filtre (örneğin, "$filter=name eq 'groupName'")
search	$search parametresi, geçirilen parametreye bağlı olarak üç farklı çıkış döndürmek için $filter parametresiyle birlikte kullanılır. $search=AllowedParents ile API, istenen varlığın kullanıcının izinleri tarafından belirlenen şekilde yeniden ayrıştırabileceği tüm grupların varlık bilgilerini döndürür. $search=AllowedChildren ile API, istenen varlığın alt öğeleri olarak eklenebilen tüm varlıkların varlık bilgilerini döndürür. $search=ParentAndFirstLevelChildren ile API, kullanıcının alt öğelerinden biri aracılığıyla doğrudan veya dolaylı erişimi olan üst ve ilk alt düzeylerini döndürür. $search=ParentOnly ile API yalnızca kullanıcının grubun alt öğelerinden en az birine erişimi varsa grubu döndürür. $search=ChildrenOnly ile API, $filter'de belirtilen grup varlığı bilgilerinin yalnızca ilk alt düzeylerini döndürür. Kullanıcının, sonuçlarda görünmesi için alt varlıklara veya alt öğelerden birine doğrudan erişimi olmalıdır.
select	Bu parametre yanıta eklenecek alanları belirtir. Herhangi bir Name,DisplayName,Type,ParentDisplayNameChain,ParentChain bileşimini içerebilir; örneğin, '$select=Ad,DisplayName,Tür,ParentDisplayNameChain,ParentNameChain'. Belirtildiğinde $select parametresi $skipToken'de seçmeyi geçersiz kılabilir.
skip	Sonuçlar alınırken atlanması gereken varlık sayısı. Bunu içeri aktarmak $skipToken geçersiz kılar.
skiptoken	Sayfa devamlılığı belirteci yalnızca önceki bir işlem kısmi sonuç döndürdüğünde kullanılır. Önceki bir yanıt bir nextLink öğesi içeriyorsa, nextLink öğesinin değeri sonraki çağrılar için kullanılacak bir başlangıç noktasını belirten bir belirteç parametresi içerir.
top	Sonuçlar alınırken döndürülecek öğe sayısı. Bunu içeri aktarmak $skipToken geçersiz kılar.
view	view parametresi, istemcilerin getEntities çağrısı tarafından döndürülen veri türünü filtrelemesine olanak tanır.

Devralınan Özellikler

abortSignal	İstekleri durdurmak için kullanılabilecek sinyal.
onResponse	İstenen işlem gerçekleştirilirken sunucudan her yanıt alındığında çağrılacak bir işlev. Birden çok kez çağrılabilir.
requestOptions	Bu işlem için HTTP istekleri oluştururken ve gönderirken kullanılan seçenekler.
serializerOptions	Serileştirme/serileştirmeyi kaldırma davranışını geçersiz kılma seçenekleri.
tracingOptions	İzleme etkinleştirildiğinde kullanılan seçenekler.

Özellik Ayrıntıları

cacheControl

İsteğin önbellek kullanıp kullanmayacağını gösterir. Mevcut önbellekleri atlamak için üst bilgiyi 'önbellek yok' değeriyle doldurun.

cacheControl?: string

Özellik Değeri

string

filter

filter parametresi, ad veya görünen ad alanlarını filtrelemenizi sağlar. Ad alanında eşitliği denetleyebilirsiniz (örneğin, eq '{entityName}' adı) ve ad veya görünen ad alanlarında (örn. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')) alt dizeleri de kontrol edebilirsiniz. '{entityName}' ve '{substringToSearch}' alanlarının büyük/küçük harfe duyarsız olarak denetlendiğini unutmayın.

filter?: string

Özellik Değeri

string

groupName

Get varlıklarının belirli bir gruba odaklanmasını sağlayan bir filtre (örneğin, "$filter=name eq 'groupName'")

groupName?: string

Özellik Değeri

string

search

$search parametresi, geçirilen parametreye bağlı olarak üç farklı çıkış döndürmek için $filter parametresiyle birlikte kullanılır. $search=AllowedParents ile API, istenen varlığın kullanıcının izinleri tarafından belirlenen şekilde yeniden ayrıştırabileceği tüm grupların varlık bilgilerini döndürür. $search=AllowedChildren ile API, istenen varlığın alt öğeleri olarak eklenebilen tüm varlıkların varlık bilgilerini döndürür. $search=ParentAndFirstLevelChildren ile API, kullanıcının alt öğelerinden biri aracılığıyla doğrudan veya dolaylı erişimi olan üst ve ilk alt düzeylerini döndürür. $search=ParentOnly ile API yalnızca kullanıcının grubun alt öğelerinden en az birine erişimi varsa grubu döndürür. $search=ChildrenOnly ile API, $filter'de belirtilen grup varlığı bilgilerinin yalnızca ilk alt düzeylerini döndürür. Kullanıcının, sonuçlarda görünmesi için alt varlıklara veya alt öğelerden birine doğrudan erişimi olmalıdır.

search?: string

Özellik Değeri

string

select

Bu parametre yanıta eklenecek alanları belirtir. Herhangi bir Name,DisplayName,Type,ParentDisplayNameChain,ParentChain bileşimini içerebilir; örneğin, '$select=Ad,DisplayName,Tür,ParentDisplayNameChain,ParentNameChain'. Belirtildiğinde $select parametresi $skipToken'de seçmeyi geçersiz kılabilir.

select?: string

Özellik Değeri

string

skip

Sonuçlar alınırken atlanması gereken varlık sayısı. Bunu içeri aktarmak $skipToken geçersiz kılar.

skip?: number

Özellik Değeri

number

skiptoken

Sayfa devamlılığı belirteci yalnızca önceki bir işlem kısmi sonuç döndürdüğünde kullanılır. Önceki bir yanıt bir nextLink öğesi içeriyorsa, nextLink öğesinin değeri sonraki çağrılar için kullanılacak bir başlangıç noktasını belirten bir belirteç parametresi içerir.

skiptoken?: string

Özellik Değeri

string

top

Sonuçlar alınırken döndürülecek öğe sayısı. Bunu içeri aktarmak $skipToken geçersiz kılar.

top?: number

Özellik Değeri

number

view

view parametresi, istemcilerin getEntities çağrısı tarafından döndürülen veri türünü filtrelemesine olanak tanır.

view?: string

Özellik Değeri

string

Devralınan Özellik Detayları

abortSignal

İstekleri durdurmak için kullanılabilecek sinyal.

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

coreClient.OperationOptions.abortSignal'dan Devralındı

onResponse

İstenen işlem gerçekleştirilirken sunucudan her yanıt alındığında çağrılacak bir işlev. Birden çok kez çağrılabilir.

onResponse?: RawResponseCallback

Özellik Değeri

RawResponseCallback

coreClient.OperationOptions.onResponse'dan Devralındı

requestOptions

Bu işlem için HTTP istekleri oluştururken ve gönderirken kullanılan seçenekler.

requestOptions?: OperationRequestOptions

Özellik Değeri

OperationRequestOptions

coreClient.OperationOptions.requestOptions'dan Devralındı

serializerOptions

Serileştirme/serileştirmeyi kaldırma davranışını geçersiz kılma seçenekleri.

serializerOptions?: SerializerOptions

Özellik Değeri

SerializerOptions

Devralınan coreClient.OperationOptions.serializerOptions

tracingOptions

İzleme etkinleştirildiğinde kullanılan seçenekler.

tracingOptions?: OperationTracingOptions

Özellik Değeri

OperationTracingOptions

coreClient.OperationOptions.tracingOptions'dan Devralındı