[AutoPR @azure/arm-search] Dev search microsoft.search 2022 09 01

sdk/search/arm-search/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Release History
 
+## 3.2.0 (2023-01-16)
+
+**Features**
+
+  - Added Interface DataPlaneAadOrApiKeyAuthOption
+  - Added Interface DataPlaneAuthOptions
+  - Added Interface EncryptionWithCmk
+  - Added Type Alias AadAuthFailureMode
+  - Added Type Alias PrivateLinkServiceConnectionProvisioningState
+  - Added Type Alias SearchEncryptionComplianceStatus
+  - Added Type Alias SearchEncryptionWithCmk
+  - Interface PrivateEndpointConnectionProperties has a new optional parameter groupId
+  - Interface PrivateEndpointConnectionProperties has a new optional parameter provisioningState
+  - Interface SearchService has a new optional parameter authOptions
+  - Interface SearchService has a new optional parameter disableLocalAuth
+  - Interface SearchService has a new optional parameter encryptionWithCmk
+  - Interface SearchServiceUpdate has a new optional parameter authOptions
+  - Interface SearchServiceUpdate has a new optional parameter disableLocalAuth
+  - Interface SearchServiceUpdate has a new optional parameter encryptionWithCmk
+  - Added Enum KnownPrivateLinkServiceConnectionProvisioningState
+
+
 ## 3.1.0 (2022-12-07)
 
 **Features**

sdk/search/arm-search/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Microsoft
+Copyright (c) 2023 Microsoft
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

sdk/search/arm-search/_meta.json

@@ -1,8 +1,8 @@
 {
-  "commit": "0cd7b3e83d5e7e21222dcc4bdde4565562da0cdf",
-  "readme": "specification\\search\\resource-manager\\readme.md",
-  "autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\search\\resource-manager\\readme.md --use=@autorest/[email protected].4  --generate-sample=true",
+  "commit": "7685470dbf38cdf6a63d3fed66c8f5fd349c010b",
+  "readme": "specification/search/resource-manager/readme.md",
+  "autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/search/resource-manager/readme.md --use=@autorest/[email protected].5",
   "repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
-  "release_tool": "@azure-tools/js-sdk-release-tools@2.5.2",
-  "use": "@autorest/[email protected].4"
+  "release_tool": "@azure-tools/js-sdk-release-tools@2.6.0",
+  "use": "@autorest/[email protected].5"
 }

sdk/search/arm-search/package.json

@@ -3,7 +3,7 @@
   "sdk-type": "mgmt",
   "author": "Microsoft Corporation",
   "description": "A generated SDK for SearchManagementClient.",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "engines": {
     "node": ">=14.0.0"
   },
@@ -110,13 +110,5 @@
       }
     ]
   },
-  "autoPublish": true,
-  "//sampleConfiguration": {
-    "productName": "",
-    "productSlugs": [
-      "azure"
-    ],
-    "disableDocsMs": true,
-    "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-search?view=azure-node-preview"
-  }
+  "autoPublish": true
 }

sdk/search/arm-search/review/arm-search.api.md

@@ -10,6 +10,9 @@ import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { PollerLike } from '@azure/core-lro';
 import { PollOperationState } from '@azure/core-lro';
 
+// @public
+export type AadAuthFailureMode = "http403" | "http401WithBearerChallenge";
+
 // @public
 export type AdminKeyKind = "primary" | "secondary";
 
@@ -72,6 +75,23 @@ export interface CloudErrorBody {
     target?: string;
 }
 
+// @public
+export interface DataPlaneAadOrApiKeyAuthOption {
+    aadAuthFailureMode?: AadAuthFailureMode;
+}
+
+// @public
+export interface DataPlaneAuthOptions {
+    aadOrApiKey?: DataPlaneAadOrApiKeyAuthOption;
+    apiKeyOnly?: Record<string, unknown>;
+}
+
+// @public
+export interface EncryptionWithCmk {
+    readonly encryptionComplianceStatus?: SearchEncryptionComplianceStatus;
+    enforcement?: SearchEncryptionWithCmk;
+}
+
 // @public
 export function getContinuationToken(page: unknown): string | undefined;
 
@@ -93,6 +113,16 @@ export interface IpRule {
     value?: string;
 }
 
+// @public
+export enum KnownPrivateLinkServiceConnectionProvisioningState {
+    Canceled = "Canceled",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Incomplete = "Incomplete",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
 // @public
 export enum KnownSharedPrivateLinkResourceAsyncOperationResult {
     Failed = "Failed",
@@ -162,8 +192,10 @@ export interface PrivateEndpointConnectionListResult {
 
 // @public
 export interface PrivateEndpointConnectionProperties {
+    groupId?: string;
     privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
     privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
+    provisioningState?: PrivateLinkServiceConnectionProvisioningState;
 }
 
 // @public
@@ -257,6 +289,9 @@ export interface PrivateLinkResourcesResult {
     readonly value?: PrivateLinkResource[];
 }
 
+// @public
+export type PrivateLinkServiceConnectionProvisioningState = string;
+
 // @public
 export type PrivateLinkServiceConnectionStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
 
@@ -315,6 +350,12 @@ export interface Resource {
     readonly type?: string;
 }
 
+// @public
+export type SearchEncryptionComplianceStatus = "Compliant" | "NonCompliant";
+
+// @public
+export type SearchEncryptionWithCmk = "Disabled" | "Enabled" | "Unspecified";
+
 // @public (undocumented)
 export class SearchManagementClient extends coreClient.ServiceClient {
     // (undocumented)
@@ -354,6 +395,9 @@ export interface SearchManagementRequestOptions {
 
 // @public
 export interface SearchService extends TrackedResource {
+    authOptions?: DataPlaneAuthOptions;
+    disableLocalAuth?: boolean;
+    encryptionWithCmk?: EncryptionWithCmk;
     hostingMode?: HostingMode;
     identity?: Identity;
     networkRuleSet?: NetworkRuleSet;
@@ -375,10 +419,13 @@ export interface SearchServiceListResult {
 }
 
 // @public
-export type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error";
+export type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error" | "stopped";
 
 // @public
 export interface SearchServiceUpdate extends Resource {
+    authOptions?: DataPlaneAuthOptions;
+    disableLocalAuth?: boolean;
+    encryptionWithCmk?: EncryptionWithCmk;
     hostingMode?: HostingMode;
     identity?: Identity;
     location?: string;

sdk/search/arm-search/src/models/index.ts

@@ -132,12 +132,41 @@ export interface IpRule {
   value?: string;
 }
 
+/** Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys. */
+export interface EncryptionWithCmk {
+  /** Describes how a search service should enforce having one or more non customer encrypted resources. */
+  enforcement?: SearchEncryptionWithCmk;
+  /**
+   * Describes whether the search service is compliant or not with respect to having non customer encrypted resources. If a service has more than one non customer encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly encryptionComplianceStatus?: SearchEncryptionComplianceStatus;
+}
+
+/** Defines the options for how the data plane API of a Search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
+export interface DataPlaneAuthOptions {
+  /** Indicates that only the API key needs to be used for authentication. */
+  apiKeyOnly?: Record<string, unknown>;
+  /** Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. */
+  aadOrApiKey?: DataPlaneAadOrApiKeyAuthOption;
+}
+
+/** Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. */
+export interface DataPlaneAadOrApiKeyAuthOption {
+  /** Describes what response the data plane API of a Search service would send for requests that failed authentication. */
+  aadAuthFailureMode?: AadAuthFailureMode;
+}
+
 /** Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. */
 export interface PrivateEndpointConnectionProperties {
   /** The private endpoint resource from Microsoft.Network provider. */
   privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
   /** Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. */
   privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
+  /** The group id from the provider of resource the private link service connection is for. */
+  groupId?: string;
+  /** The provisioning state of the private link service connection. Can be Updating, Deleting, Failed, Succeeded, or Incomplete */
+  provisioningState?: PrivateLinkServiceConnectionProvisioningState;
 }
 
 /** The private endpoint resource from Microsoft.Network provider. */
@@ -200,12 +229,12 @@ export interface Sku {
 /** Identity for the resource. */
 export interface Identity {
   /**
-   * The principal ID of resource identity.
+   * The principal ID of the system-assigned identity of the search service.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly principalId?: string;
   /**
-   * The tenant ID of resource.
+   * The tenant ID of the system-assigned identity of the search service.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly tenantId?: string;
@@ -216,7 +245,7 @@ export interface Identity {
 /** Response containing a list of Azure Cognitive Search services. */
 export interface SearchServiceListResult {
   /**
-   * The list of search services.
+   * The list of Search services.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly value?: SearchService[];
@@ -406,6 +435,12 @@ export interface SearchServiceUpdate extends Resource {
   readonly provisioningState?: ProvisioningState;
   /** Network specific rules that determine how the Azure Cognitive Search service may be reached. */
   networkRuleSet?: NetworkRuleSet;
+  /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
+  encryptionWithCmk?: EncryptionWithCmk;
+  /** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
+  disableLocalAuth?: boolean;
+  /** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
+  authOptions?: DataPlaneAuthOptions;
   /**
    * The list of private endpoint connections to the Azure Cognitive Search service.
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -458,6 +493,12 @@ export interface SearchService extends TrackedResource {
   readonly provisioningState?: ProvisioningState;
   /** Network specific rules that determine how the Azure Cognitive Search service may be reached. */
   networkRuleSet?: NetworkRuleSet;
+  /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
+  encryptionWithCmk?: EncryptionWithCmk;
+  /** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
+  disableLocalAuth?: boolean;
+  /** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
+  authOptions?: DataPlaneAuthOptions;
   /**
    * The list of private endpoint connections to the Azure Cognitive Search service.
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -476,11 +517,41 @@ export interface SearchManagementRequestOptions {
   clientRequestId?: string;
 }
 
+/** Known values of {@link PrivateLinkServiceConnectionProvisioningState} that the service accepts. */
+export enum KnownPrivateLinkServiceConnectionProvisioningState {
+  /** The private link service connection is in the process of being created along with other resources for it to be fully functional. */
+  Updating = "Updating",
+  /** The private link service connection is in the process of being deleted. */
+  Deleting = "Deleting",
+  /** The private link service connection has failed to be provisioned or deleted. */
+  Failed = "Failed",
+  /** The private link service connection has finished provisioning and is ready for approval. */
+  Succeeded = "Succeeded",
+  /** Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. */
+  Incomplete = "Incomplete",
+  /** Provisioning request for the private link service connection resource has been canceled */
+  Canceled = "Canceled"
+}
+
+/**
+ * Defines values for PrivateLinkServiceConnectionProvisioningState. \
+ * {@link KnownPrivateLinkServiceConnectionProvisioningState} can be used interchangeably with PrivateLinkServiceConnectionProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Updating**: The private link service connection is in the process of being created along with other resources for it to be fully functional. \
+ * **Deleting**: The private link service connection is in the process of being deleted. \
+ * **Failed**: The private link service connection has failed to be provisioned or deleted. \
+ * **Succeeded**: The private link service connection has finished provisioning and is ready for approval. \
+ * **Incomplete**: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. \
+ * **Canceled**: Provisioning request for the private link service connection resource has been canceled
+ */
+export type PrivateLinkServiceConnectionProvisioningState = string;
+
 /** Known values of {@link UnavailableNameReason} that the service accepts. */
 export enum KnownUnavailableNameReason {
-  /** Invalid */
+  /** The search service name does not match naming requirements. */
   Invalid = "Invalid",
-  /** AlreadyExists */
+  /** The search service name is already assigned to a different search service. */
   AlreadyExists = "AlreadyExists"
 }
 
@@ -489,8 +560,8 @@ export enum KnownUnavailableNameReason {
  * {@link KnownUnavailableNameReason} can be used interchangeably with UnavailableNameReason,
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
- * **Invalid** \
- * **AlreadyExists**
+ * **Invalid**: The search service name does not match naming requirements. \
+ * **AlreadyExists**: The search service name is already assigned to a different search service.
  */
 export type UnavailableNameReason = string;
 
@@ -527,9 +598,16 @@ export type SearchServiceStatus =
   | "deleting"
   | "degraded"
   | "disabled"
-  | "error";
+  | "error"
+  | "stopped";
 /** Defines values for ProvisioningState. */
 export type ProvisioningState = "succeeded" | "provisioning" | "failed";
+/** Defines values for SearchEncryptionWithCmk. */
+export type SearchEncryptionWithCmk = "Disabled" | "Enabled" | "Unspecified";
+/** Defines values for SearchEncryptionComplianceStatus. */
+export type SearchEncryptionComplianceStatus = "Compliant" | "NonCompliant";
+/** Defines values for AadAuthFailureMode. */
+export type AadAuthFailureMode = "http403" | "http401WithBearerChallenge";
 /** Defines values for PrivateLinkServiceConnectionStatus. */
 export type PrivateLinkServiceConnectionStatus =
   | "Pending"