EntitiesListOptionalParams interface

Pakiet:

@azure/arm-managementgroups

Parametry opcjonalne.

Extends

OperationOptions

Właściwości

cacheControl	Wskazuje, czy żądanie powinno korzystać z jakichkolwiek pamięci podręcznych. Wypełnij nagłówek wartością "no-cache", aby pominąć istniejące pamięci podręczne.
filter	Parametr filtru umożliwia filtrowanie pól nazwy lub nazwy wyświetlanej. Możesz sprawdzić równość w polu nazwy (np. name eq "{entityName}") i sprawdzić podciąg w polach nazwy lub nazwy wyświetlanej (np. contains(name, "{substringToSearch}"), contains(displayName, "{substringToSearch")). Należy pamiętać, że pola "{entityName}" i "{substringToSearch}" są sprawdzane bez uwzględniania wielkości liter.
groupName	Filtr, który umożliwia wywołanie metody get, aby skupić się na określonej grupie (tj. "$filter=name eq 'groupName'")
search	Parametr $search jest używany w połączeniu z parametrem $filter, aby zwrócić trzy różne dane wyjściowe w zależności od przekazanego parametru. W przypadku $search=AllowedParents interfejs API zwróci informacje o jednostce wszystkich grup, do których żądana jednostka będzie mogła wykonać reparent zgodnie z uprawnieniami użytkownika. W przypadku $search=AllowedChildren interfejs API zwróci informacje o jednostce wszystkich jednostek, które można dodać jako elementy podrzędne żądanej jednostki. W przypadku $search=ParentAndFirstLevelChildren interfejs API zwróci element nadrzędny i pierwszy poziom elementów podrzędnych, do których użytkownik ma bezpośredni dostęp lub dostęp pośredni za pośrednictwem jednego z elementów potomnych. W przypadku $search=ParentOnly interfejs API zwróci tylko grupę, jeśli użytkownik ma dostęp do co najmniej jednego elementu podrzędnego grupy. W przypadku $search=ChildrenOnly interfejs API zwróci tylko pierwszy poziom elementów podrzędnych informacji o jednostce grupy określonych w $filter. Użytkownik musi mieć bezpośredni dostęp do jednostek podrzędnych lub jednego z elementów podrzędnych, aby był widoczny w wynikach.
select	Ten parametr określa pola do uwzględnienia w odpowiedzi. Może zawierać dowolną kombinację wartości Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, np. "$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain". Po określeniu parametru $select można zastąpić wybór w $skipToken.
skip	Liczba jednostek do pominięcia podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.
skiptoken	Token kontynuacji strony jest używany tylko wtedy, gdy poprzednia operacja zwróciła częściowy wynik. Jeśli poprzednia odpowiedź zawiera element nextLink, wartość elementu nextLink będzie zawierać parametr tokenu, który określa punkt wyjścia do użycia dla kolejnych wywołań.
top	Liczba elementów, które mają być zwracane podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.
view	Parametr widoku umożliwia klientom filtrowanie typu danych zwracanych przez wywołanie getEntities.

Właściwości dziedziczone

abortSignal	Sygnał, który może służyć do przerwania żądań.
onResponse	Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
requestOptions	Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
serializerOptions	Opcje zastępowania zachowania serializacji/deseralizacji.
tracingOptions	Opcje używane podczas śledzenia jest włączone.

Szczegóły właściwości

cacheControl

Wskazuje, czy żądanie powinno korzystać z jakichkolwiek pamięci podręcznych. Wypełnij nagłówek wartością "no-cache", aby pominąć istniejące pamięci podręczne.

cacheControl?: string

Wartość właściwości

string

filter

Parametr filtru umożliwia filtrowanie pól nazwy lub nazwy wyświetlanej. Możesz sprawdzić równość w polu nazwy (np. name eq "{entityName}") i sprawdzić podciąg w polach nazwy lub nazwy wyświetlanej (np. contains(name, "{substringToSearch}"), contains(displayName, "{substringToSearch")). Należy pamiętać, że pola "{entityName}" i "{substringToSearch}" są sprawdzane bez uwzględniania wielkości liter.

filter?: string

Wartość właściwości

string

groupName

Filtr, który umożliwia wywołanie metody get, aby skupić się na określonej grupie (tj. "$filter=name eq 'groupName'")

groupName?: string

Wartość właściwości

string

search

Parametr $search jest używany w połączeniu z parametrem $filter, aby zwrócić trzy różne dane wyjściowe w zależności od przekazanego parametru. W przypadku $search=AllowedParents interfejs API zwróci informacje o jednostce wszystkich grup, do których żądana jednostka będzie mogła wykonać reparent zgodnie z uprawnieniami użytkownika. W przypadku $search=AllowedChildren interfejs API zwróci informacje o jednostce wszystkich jednostek, które można dodać jako elementy podrzędne żądanej jednostki. W przypadku $search=ParentAndFirstLevelChildren interfejs API zwróci element nadrzędny i pierwszy poziom elementów podrzędnych, do których użytkownik ma bezpośredni dostęp lub dostęp pośredni za pośrednictwem jednego z elementów potomnych. W przypadku $search=ParentOnly interfejs API zwróci tylko grupę, jeśli użytkownik ma dostęp do co najmniej jednego elementu podrzędnego grupy. W przypadku $search=ChildrenOnly interfejs API zwróci tylko pierwszy poziom elementów podrzędnych informacji o jednostce grupy określonych w $filter. Użytkownik musi mieć bezpośredni dostęp do jednostek podrzędnych lub jednego z elementów podrzędnych, aby był widoczny w wynikach.

search?: string

Wartość właściwości

string

select

Ten parametr określa pola do uwzględnienia w odpowiedzi. Może zawierać dowolną kombinację wartości Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, np. "$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain". Po określeniu parametru $select można zastąpić wybór w $skipToken.

select?: string

Wartość właściwości

string

skip

Liczba jednostek do pominięcia podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.

skip?: number

Wartość właściwości

number

skiptoken

Token kontynuacji strony jest używany tylko wtedy, gdy poprzednia operacja zwróciła częściowy wynik. Jeśli poprzednia odpowiedź zawiera element nextLink, wartość elementu nextLink będzie zawierać parametr tokenu, który określa punkt wyjścia do użycia dla kolejnych wywołań.

skiptoken?: string

Wartość właściwości

string

top

Liczba elementów, które mają być zwracane podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.

top?: number

Wartość właściwości

number

view

Parametr widoku umożliwia klientom filtrowanie typu danych zwracanych przez wywołanie getEntities.

view?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

Dziedziczone z coreClient.OperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

RawResponseCallback

Dziedziczone z coreClient.OperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

OperationRequestOptions

Dziedziczone z coreClient.OperationOptions.requestOptions

serializerOptions

Opcje zastępowania zachowania serializacji/deseralizacji.

serializerOptions?: SerializerOptions

Wartość właściwości

SerializerOptions

Dziedziczone z coreClient.OperationOptions.serializerOptions

tracingOptions

Opcje używane podczas śledzenia jest włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

Dziedziczone z coreClient.OperationOptions.tracingOptions