EntitiesListNextOptionalParams interface

패키지:

@azure/arm-managementgroups

선택적 매개 변수입니다.

Extends

OperationOptions

속성

cacheControl	요청이 캐시를 활용해야 하는지 여부를 나타냅니다. 기존 캐시를 무시하려면 헤더를 'no-cache' 값으로 채웁니다.
filter	filter 매개 변수를 사용하면 이름 또는 표시 이름 필드를 필터링할 수 있습니다. 이름 필드(예: 이름 eq '{entityName}')에서 같음을 확인할 수 있으며 이름 또는 표시 이름 필드(예: contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')에서 부분 문자열을 확인할 수 있습니다. '{entityName}' 및 '{substringToSearch}' 필드는 대/소문자를 구분하지 않고 검사됩니다.
groupName	get 엔터티 호출이 특정 그룹에 집중할 수 있도록 하는 필터(예: "$filter=name eq 'groupName'")
search	$search 매개 변수는 전달된 매개 변수에 따라 세 가지 다른 출력을 반환하기 위해 $filter 매개 변수와 함께 사용됩니다. $search=AllowedParents를 사용하면 API는 요청된 엔터티가 사용자의 권한에 따라 재분석할 수 있는 모든 그룹의 엔터티 정보를 반환합니다. $search=AllowedChildren를 사용하면 API는 요청된 엔터티의 자식으로 추가할 수 있는 모든 엔터티의 엔터티 정보를 반환합니다. $search=ParentAndFirstLevelChildren를 사용하면 API는 사용자가 하위 항목 중 하나를 통해 직접 액세스하거나 간접적으로 액세스할 수 있는 부모 및 첫 번째 수준의 자식을 반환합니다. $search=ParentOnly를 사용하면 API는 사용자가 그룹의 하위 항목 중 하나 이상에 액세스할 수 있는 경우에만 그룹을 반환합니다. $search=ChildrenOnly를 사용하면 API는 $filter 지정된 그룹 엔터티 정보의 첫 번째 수준의 자식만 반환합니다. 결과에 표시하려면 사용자가 자식 엔터티 또는 하위 엔터티 중 하나에 직접 액세스할 수 있어야 합니다.
select	이 매개 변수는 응답에 포함할 필드를 지정합니다. Name,DisplayName,Type,ParentDisplayNameChain,ParentChain의 조합을 포함할 수 있습니다(예: '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'). 지정된 경우 $select 매개 변수는 $skipToken 선택을 재정의할 수 있습니다.
skip	결과를 검색할 때 건너뛸 엔터티 수입니다. 이 를 에 전달하면 $skipToken 재정의됩니다.
skiptoken	페이지 연속 토큰은 이전 작업에서 부분 결과를 반환한 경우에만 사용됩니다. 이전 응답에 nextLink 요소가 포함된 경우 nextLink 요소의 값에는 후속 호출에 사용할 시작점을 지정하는 토큰 매개 변수가 포함됩니다.
top	결과를 검색할 때 반환할 요소 수입니다. 이 를 에 전달하면 $skipToken 재정의됩니다.
view	view 매개 변수를 사용하면 클라이언트가 getEntities 호출에서 반환되는 데이터 형식을 필터링할 수 있습니다.

상속된 속성

abortSignal	요청을 중단하는 데 사용할 수 있는 신호입니다.
onResponse	요청된 작업을 수행하는 동안 서버에서 응답을 받을 때마다 호출되는 함수입니다. 여러 번 호출할 수 있습니다.
requestOptions	이 작업에 대한 HTTP 요청을 만들고 보낼 때 사용되는 옵션입니다.
serializerOptions	serialization/de-serialization 동작을 재정의하는 옵션입니다.
tracingOptions	추적을 사용할 때 사용되는 옵션입니다.

속성 세부 정보

cacheControl

요청이 캐시를 활용해야 하는지 여부를 나타냅니다. 기존 캐시를 무시하려면 헤더를 'no-cache' 값으로 채웁니다.

cacheControl?: string

속성 값

string

filter

filter 매개 변수를 사용하면 이름 또는 표시 이름 필드를 필터링할 수 있습니다. 이름 필드(예: 이름 eq '{entityName}')에서 같음을 확인할 수 있으며 이름 또는 표시 이름 필드(예: contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')에서 부분 문자열을 확인할 수 있습니다. '{entityName}' 및 '{substringToSearch}' 필드는 대/소문자를 구분하지 않고 검사됩니다.

filter?: string

속성 값

string

groupName

get 엔터티 호출이 특정 그룹에 집중할 수 있도록 하는 필터(예: "$filter=name eq 'groupName'")

groupName?: string

속성 값

string

search

$search 매개 변수는 전달된 매개 변수에 따라 세 가지 다른 출력을 반환하기 위해 $filter 매개 변수와 함께 사용됩니다. $search=AllowedParents를 사용하면 API는 요청된 엔터티가 사용자의 권한에 따라 재분석할 수 있는 모든 그룹의 엔터티 정보를 반환합니다. $search=AllowedChildren를 사용하면 API는 요청된 엔터티의 자식으로 추가할 수 있는 모든 엔터티의 엔터티 정보를 반환합니다. $search=ParentAndFirstLevelChildren를 사용하면 API는 사용자가 하위 항목 중 하나를 통해 직접 액세스하거나 간접적으로 액세스할 수 있는 부모 및 첫 번째 수준의 자식을 반환합니다. $search=ParentOnly를 사용하면 API는 사용자가 그룹의 하위 항목 중 하나 이상에 액세스할 수 있는 경우에만 그룹을 반환합니다. $search=ChildrenOnly를 사용하면 API는 $filter 지정된 그룹 엔터티 정보의 첫 번째 수준의 자식만 반환합니다. 결과에 표시하려면 사용자가 자식 엔터티 또는 하위 엔터티 중 하나에 직접 액세스할 수 있어야 합니다.

search?: string

속성 값

string

select

이 매개 변수는 응답에 포함할 필드를 지정합니다. Name,DisplayName,Type,ParentDisplayNameChain,ParentChain의 조합을 포함할 수 있습니다(예: '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'). 지정된 경우 $select 매개 변수는 $skipToken 선택을 재정의할 수 있습니다.

select?: string

속성 값

string

skip

결과를 검색할 때 건너뛸 엔터티 수입니다. 이 를 에 전달하면 $skipToken 재정의됩니다.

skip?: number

속성 값

number

skiptoken

페이지 연속 토큰은 이전 작업에서 부분 결과를 반환한 경우에만 사용됩니다. 이전 응답에 nextLink 요소가 포함된 경우 nextLink 요소의 값에는 후속 호출에 사용할 시작점을 지정하는 토큰 매개 변수가 포함됩니다.

skiptoken?: string

속성 값

string

top

결과를 검색할 때 반환할 요소 수입니다. 이 를 에 전달하면 $skipToken 재정의됩니다.

top?: number

속성 값

number

view

view 매개 변수를 사용하면 클라이언트가 getEntities 호출에서 반환되는 데이터 형식을 필터링할 수 있습니다.

view?: string

속성 값

string

상속된 속성 세부 정보

abortSignal

요청을 중단하는 데 사용할 수 있는 신호입니다.

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

coreClient.OperationOptions.abortSignal에서 상속됨

onResponse

요청된 작업을 수행하는 동안 서버에서 응답을 받을 때마다 호출되는 함수입니다. 여러 번 호출할 수 있습니다.

onResponse?: RawResponseCallback

속성 값

RawResponseCallback

coreClient.OperationOptions.onResponse에서 상속됨

requestOptions

이 작업에 대한 HTTP 요청을 만들고 보낼 때 사용되는 옵션입니다.

requestOptions?: OperationRequestOptions

속성 값

OperationRequestOptions

coreClient.OperationOptions.requestOptions에서 상속됨

serializerOptions

serialization/de-serialization 동작을 재정의하는 옵션입니다.

serializerOptions?: SerializerOptions

속성 값

SerializerOptions

coreClient.OperationOptions.serializerOptions에서 상속됨

tracingOptions

추적을 사용할 때 사용되는 옵션입니다.

tracingOptions?: OperationTracingOptions

속성 값

OperationTracingOptions

coreClient.OperationOptions.tracingOptions에서 상속됨