Update PowerShell SDK docs: 15141274669

This commit is contained in:
developer-relations-sp
2025-05-20 15:12:17 +00:00
parent c4f4d72fc8
commit 8df9b19e41
308 changed files with 6591 additions and 5586 deletions

View File

@@ -0,0 +1,49 @@
---
id: beta-search-criteria
title: SearchCriteria
pagination_label: SearchCriteria
sidebar_label: SearchCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteria', 'BetaSearchCriteria']
slug: /tools/sdk/powershell/beta/models/search-criteria
tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'BetaSearchCriteria']
---
# SearchCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | **[]String** | A list of indices to search within. Must contain exactly one item, typically ""entitlements"". | [required]
**Filters** | [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional]
**Query** | [**SearchCriteriaQuery**](search-criteria-query) | | [optional]
**QueryType** | **String** | Specifies the type of query. Must be ""TEXT"" if `textQuery` is used. | [optional]
**TextQuery** | [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional]
**IncludeNested** | **Boolean** | Whether to include nested objects in the search results. | [optional] [default to $false]
**Sort** | **[]String** | Specifies the sorting order for the results. | [optional]
**SearchAfter** | **[]String** | Used for pagination to fetch results after a specific point. | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteria = Initialize-BetaSearchCriteria -Indices [entitlements] `
-Filters {status={type=TERMS, terms=[active, inactive]}} `
-Query null `
-QueryType TEXT `
-TextQuery null `
-IncludeNested true `
-Sort [name:asc, createdAt:desc] `
-SearchAfter [12345, 67890]
```
- Convert the resource to JSON
```powershell
$SearchCriteria | ConvertTo-JSON
```
[[Back to top]](#)