@azure/arm-search 1.3.0 → 3.0.0-beta.1

package/review/arm-search.api.md

@@ -0,0 +1,600 @@
+## API Report File for "@azure/arm-search"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export type AdminKeyKind = "primary" | "secondary";
+
+// @public
+export interface AdminKeyResult {
+    readonly primaryKey?: string;
+    readonly secondaryKey?: string;
+}
+
+// @public
+export interface AdminKeys {
+    get(resourceGroupName: string, searchServiceName: string, options?: AdminKeysGetOptionalParams): Promise<AdminKeysGetResponse>;
+    regenerate(resourceGroupName: string, searchServiceName: string, keyKind: AdminKeyKind, options?: AdminKeysRegenerateOptionalParams): Promise<AdminKeysRegenerateResponse>;
+}
+
+// @public
+export interface AdminKeysGetOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type AdminKeysGetResponse = AdminKeyResult;
+
+// @public
+export interface AdminKeysRegenerateOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type AdminKeysRegenerateResponse = AdminKeyResult;
+
+// @public
+export interface AsyncOperationResult {
+    status?: SharedPrivateLinkResourceAsyncOperationResult;
+}
+
+// @public
+export interface CheckNameAvailabilityInput {
+    name: string;
+    type: "searchServices";
+}
+
+// @public
+export interface CheckNameAvailabilityOutput {
+    readonly isNameAvailable?: boolean;
+    readonly message?: string;
+    readonly reason?: UnavailableNameReason;
+}
+
+// @public
+export interface CloudError {
+    error?: CloudErrorBody;
+}
+
+// @public
+export interface CloudErrorBody {
+    code?: string;
+    details?: CloudErrorBody[];
+    message?: string;
+    target?: string;
+}
+
+// @public
+export type HostingMode = "default" | "highDensity";
+
+// @public
+export interface Identity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: IdentityType;
+}
+
+// @public
+export type IdentityType = "None" | "SystemAssigned";
+
+// @public
+export interface IpRule {
+    value?: string;
+}
+
+// @public
+export enum KnownSharedPrivateLinkResourceAsyncOperationResult {
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    Running = "Running",
+    // (undocumented)
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownUnavailableNameReason {
+    // (undocumented)
+    AlreadyExists = "AlreadyExists",
+    // (undocumented)
+    Invalid = "Invalid"
+}
+
+// @public
+export interface ListQueryKeysResult {
+    readonly nextLink?: string;
+    readonly value?: QueryKey[];
+}
+
+// @public
+export interface NetworkRuleSet {
+    ipRules?: IpRule[];
+}
+
+// @public
+export interface Operation {
+    readonly display?: OperationDisplay;
+    readonly name?: string;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export type PrivateEndpointConnection = Resource & {
+    properties?: PrivateEndpointConnectionProperties;
+};
+
+// @public
+export interface PrivateEndpointConnectionListResult {
+    readonly nextLink?: string;
+    readonly value?: PrivateEndpointConnection[];
+}
+
+// @public
+export interface PrivateEndpointConnectionProperties {
+    privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
+    privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
+}
+
+// @public
+export interface PrivateEndpointConnectionPropertiesPrivateEndpoint {
+    id?: string;
+}
+
+// @public
+export interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {
+    actionsRequired?: string;
+    description?: string;
+    status?: PrivateLinkServiceConnectionStatus;
+}
+
+// @public
+export interface PrivateEndpointConnections {
+    delete(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteResponse>;
+    get(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
+    listByService(resourceGroupName: string, searchServiceName: string, options?: PrivateEndpointConnectionsListByServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
+    update(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<PrivateEndpointConnectionsUpdateResponse>;
+}
+
+// @public
+export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type PrivateEndpointConnectionsDeleteResponse = PrivateEndpointConnection;
+
+// @public
+export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
+
+// @public
+export interface PrivateEndpointConnectionsListByServiceNextOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type PrivateEndpointConnectionsListByServiceNextResponse = PrivateEndpointConnectionListResult;
+
+// @public
+export interface PrivateEndpointConnectionsListByServiceOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type PrivateEndpointConnectionsListByServiceResponse = PrivateEndpointConnectionListResult;
+
+// @public
+export interface PrivateEndpointConnectionsUpdateOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type PrivateEndpointConnectionsUpdateResponse = PrivateEndpointConnection;
+
+// @public
+export type PrivateLinkResource = Resource & {
+    readonly properties?: PrivateLinkResourceProperties;
+};
+
+// @public
+export interface PrivateLinkResourceProperties {
+    readonly groupId?: string;
+    readonly requiredMembers?: string[];
+    readonly requiredZoneNames?: string[];
+    readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[];
+}
+
+// @public
+export interface PrivateLinkResources {
+    listSupported(resourceGroupName: string, searchServiceName: string, options?: PrivateLinkResourcesListSupportedOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
+}
+
+// @public
+export interface PrivateLinkResourcesListSupportedOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type PrivateLinkResourcesListSupportedResponse = PrivateLinkResourcesResult;
+
+// @public
+export interface PrivateLinkResourcesResult {
+    readonly value?: PrivateLinkResource[];
+}
+
+// @public
+export type PrivateLinkServiceConnectionStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
+
+// @public
+export type ProvisioningState = "succeeded" | "provisioning" | "failed";
+
+// @public
+export type PublicNetworkAccess = "enabled" | "disabled";
+
+// @public
+export interface QueryKey {
+    readonly key?: string;
+    readonly name?: string;
+}
+
+// @public
+export interface QueryKeys {
+    create(resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams): Promise<QueryKeysCreateResponse>;
+    delete(resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams): Promise<void>;
+    listBySearchService(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams): PagedAsyncIterableIterator<QueryKey>;
+}
+
+// @public
+export interface QueryKeysCreateOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type QueryKeysCreateResponse = QueryKey;
+
+// @public
+export interface QueryKeysDeleteOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export interface QueryKeysListBySearchServiceNextOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type QueryKeysListBySearchServiceNextResponse = ListQueryKeysResult;
+
+// @public
+export interface QueryKeysListBySearchServiceOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type QueryKeysListBySearchServiceResponse = ListQueryKeysResult;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public (undocumented)
+export class SearchManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: SearchManagementClientOptionalParams);
+    // (undocumented)
+    adminKeys: AdminKeys;
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    privateEndpointConnections: PrivateEndpointConnections;
+    // (undocumented)
+    privateLinkResources: PrivateLinkResources;
+    // (undocumented)
+    queryKeys: QueryKeys;
+    // (undocumented)
+    services: Services;
+    // (undocumented)
+    sharedPrivateLinkResources: SharedPrivateLinkResources;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface SearchManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface SearchManagementRequestOptions {
+    clientRequestId?: string;
+}
+
+// @public
+export type SearchService = TrackedResource & {
+    sku?: Sku;
+    identity?: Identity;
+    replicaCount?: number;
+    partitionCount?: number;
+    hostingMode?: HostingMode;
+    publicNetworkAccess?: PublicNetworkAccess;
+    readonly status?: SearchServiceStatus;
+    readonly statusDetails?: string;
+    readonly provisioningState?: ProvisioningState;
+    networkRuleSet?: NetworkRuleSet;
+    readonly privateEndpointConnections?: PrivateEndpointConnection[];
+    readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
+};
+
+// @public
+export interface SearchServiceListResult {
+    readonly nextLink?: string;
+    readonly value?: SearchService[];
+}
+
+// @public
+export type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error";
+
+// @public
+export type SearchServiceUpdate = Resource & {
+    sku?: Sku;
+    location?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    identity?: Identity;
+    replicaCount?: number;
+    partitionCount?: number;
+    hostingMode?: HostingMode;
+    publicNetworkAccess?: PublicNetworkAccess;
+    readonly status?: SearchServiceStatus;
+    readonly statusDetails?: string;
+    readonly provisioningState?: ProvisioningState;
+    networkRuleSet?: NetworkRuleSet;
+    readonly privateEndpointConnections?: PrivateEndpointConnection[];
+    readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
+};
+
+// @public
+export interface Services {
+    beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ServicesCreateOrUpdateResponse>, ServicesCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<ServicesCreateOrUpdateResponse>;
+    checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<ServicesCheckNameAvailabilityResponse>;
+    delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<ServicesGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SearchService>;
+    listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SearchService>;
+    update(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<ServicesUpdateResponse>;
+}
+
+// @public
+export interface ServicesCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type ServicesCheckNameAvailabilityResponse = CheckNameAvailabilityOutput;
+
+// @public
+export interface ServicesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ServicesCreateOrUpdateResponse = SearchService;
+
+// @public
+export interface ServicesDeleteOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export interface ServicesGetOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type ServicesGetResponse = SearchService;
+
+// @public
+export interface ServicesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type ServicesListByResourceGroupNextResponse = SearchServiceListResult;
+
+// @public
+export interface ServicesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type ServicesListByResourceGroupResponse = SearchServiceListResult;
+
+// @public
+export interface ServicesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type ServicesListBySubscriptionNextResponse = SearchServiceListResult;
+
+// @public
+export interface ServicesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type ServicesListBySubscriptionResponse = SearchServiceListResult;
+
+// @public
+export interface ServicesUpdateOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type ServicesUpdateResponse = SearchService;
+
+// @public
+export interface ShareablePrivateLinkResourceProperties {
+    readonly description?: string;
+    readonly groupId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface ShareablePrivateLinkResourceType {
+    readonly name?: string;
+    readonly properties?: ShareablePrivateLinkResourceProperties;
+}
+
+// @public
+export type SharedPrivateLinkResource = Resource & {
+    properties?: SharedPrivateLinkResourceProperties;
+};
+
+// @public
+export type SharedPrivateLinkResourceAsyncOperationResult = string;
+
+// @public
+export interface SharedPrivateLinkResourceListResult {
+    nextLink?: string;
+    readonly value?: SharedPrivateLinkResource[];
+}
+
+// @public
+export interface SharedPrivateLinkResourceProperties {
+    groupId?: string;
+    privateLinkResourceId?: string;
+    provisioningState?: SharedPrivateLinkResourceProvisioningState;
+    requestMessage?: string;
+    resourceRegion?: string;
+    status?: SharedPrivateLinkResourceStatus;
+}
+
+// @public
+export type SharedPrivateLinkResourceProvisioningState = "Updating" | "Deleting" | "Failed" | "Succeeded" | "Incomplete";
+
+// @public
+export interface SharedPrivateLinkResources {
+    beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, sharedPrivateLinkResource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SharedPrivateLinkResourcesCreateOrUpdateResponse>, SharedPrivateLinkResourcesCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, sharedPrivateLinkResource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<SharedPrivateLinkResourcesCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesGetOptionalParams): Promise<SharedPrivateLinkResourcesGetResponse>;
+    listByService(resourceGroupName: string, searchServiceName: string, options?: SharedPrivateLinkResourcesListByServiceOptionalParams): PagedAsyncIterableIterator<SharedPrivateLinkResource>;
+}
+
+// @public
+export interface SharedPrivateLinkResourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type SharedPrivateLinkResourcesCreateOrUpdateResponse = SharedPrivateLinkResource;
+
+// @public
+export interface SharedPrivateLinkResourcesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface SharedPrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type SharedPrivateLinkResourcesGetResponse = SharedPrivateLinkResource;
+
+// @public
+export interface SharedPrivateLinkResourcesListByServiceNextOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type SharedPrivateLinkResourcesListByServiceNextResponse = SharedPrivateLinkResourceListResult;
+
+// @public
+export interface SharedPrivateLinkResourcesListByServiceOptionalParams extends coreClient.OperationOptions {
+    searchManagementRequestOptions?: SearchManagementRequestOptions;
+}
+
+// @public
+export type SharedPrivateLinkResourcesListByServiceResponse = SharedPrivateLinkResourceListResult;
+
+// @public
+export type SharedPrivateLinkResourceStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
+
+// @public
+export interface Sku {
+    name?: SkuName;
+}
+
+// @public
+export type SkuName = "free" | "basic" | "standard" | "standard2" | "standard3" | "storage_optimized_l1" | "storage_optimized_l2";
+
+// @public
+export type TrackedResource = Resource & {
+    tags?: {
+        [propertyName: string]: string;
+    };
+    location: string;
+};
+
+// @public
+export type UnavailableNameReason = string;
+
+// (No @packageDocumentation comment for this package)
+
+```