From 4f639590d54faf6ee0235de018c018ae7d9e3af7 Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Thu, 12 Jan 2023 19:58:04 +0000 Subject: [PATCH] CodeGen from PR 21964 in Azure/azure-rest-api-specs Merge 63d6de9670c84075586b67e106cbb5d6a6e5cc13 into db511f9fb764f11d9fe17422ea56a6db87477b37 --- schemas/2022-09-01/Microsoft.Search.json | 663 +++++++++++++++++++++ schemas/common/autogeneratedResources.json | 9 + 2 files changed, 672 insertions(+) create mode 100644 schemas/2022-09-01/Microsoft.Search.json diff --git a/schemas/2022-09-01/Microsoft.Search.json b/schemas/2022-09-01/Microsoft.Search.json new file mode 100644 index 0000000000..3af1f04904 --- /dev/null +++ b/schemas/2022-09-01/Microsoft.Search.json @@ -0,0 +1,663 @@ +{ + "id": "https://schema.management.azure.com/schemas/2022-09-01/Microsoft.Search.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Search", + "description": "Microsoft Search Resource Types", + "resourceDefinitions": { + "searchServices": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2022-09-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/Identity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the resource." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "name": { + "type": "string", + "description": "The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SearchServiceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the search service." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/searchServices_privateEndpointConnections_childResource" + }, + { + "$ref": "#/definitions/searchServices_sharedPrivateLinkResources_childResource" + } + ] + } + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Search/searchServices" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Search/searchServices" + }, + "searchServices_privateEndpointConnections": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2022-09-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Search/searchServices/privateEndpointConnections" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Search/searchServices/privateEndpointConnections" + }, + "searchServices_sharedPrivateLinkResources": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2022-09-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Search/searchServices/sharedPrivateLinkResources" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Search/searchServices/sharedPrivateLinkResources" + } + }, + "definitions": { + "DataPlaneAadOrApiKeyAuthOption": { + "type": "object", + "properties": { + "aadAuthFailureMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "http403", + "http401WithBearerChallenge" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes what response the data plane API of a Search service would send for requests that failed authentication." + } + }, + "description": "Indicates that either the API key or an access token from Azure Active Directory can be used for authentication." + }, + "DataPlaneAuthOptions": { + "type": "object", + "properties": { + "aadOrApiKey": { + "oneOf": [ + { + "$ref": "#/definitions/DataPlaneAadOrApiKeyAuthOption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates that either the API key or an access token from Azure Active Directory can be used for authentication." + }, + "apiKeyOnly": { + "type": "object", + "properties": {}, + "description": "Indicates that only the API key needs to be used for authentication." + } + }, + "description": "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." + }, + "EncryptionWithCmk": { + "type": "object", + "properties": { + "enforcement": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Disabled", + "Enabled", + "Unspecified" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes how a search service should enforce having one or more non customer encrypted resources." + } + }, + "description": "Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys." + }, + "Identity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The identity type." + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." + }, + "IpRule": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed." + } + }, + "description": "The IP restriction rule of the Azure Cognitive Search service." + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "ipRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/IpRule" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method." + } + }, + "description": "Network specific rules that determine how the Azure Cognitive Search service may be reached." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id from the provider of resource the private link service connection is for." + }, + "privateEndpoint": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionPropertiesPrivateEndpoint" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The private endpoint resource from Microsoft.Network provider." + }, + "privateLinkServiceConnectionState": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint." + }, + "provisioningState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Updating", + "Deleting", + "Failed", + "Succeeded", + "Incomplete", + "Canceled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The provisioning state of the private link service connection. Can be Updating, Deleting, Failed, Succeeded, or Incomplete." + } + }, + "description": "Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service." + }, + "PrivateEndpointConnectionPropertiesPrivateEndpoint": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The resource id of the private endpoint resource from Microsoft.Network provider." + } + }, + "description": "The private endpoint resource from Microsoft.Network provider." + }, + "PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "actionsRequired": { + "type": "string", + "default": "None", + "description": "A description of any extra actions that may be required." + }, + "description": { + "type": "string", + "description": "The description for the private link service connection state." + }, + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected." + } + }, + "description": "Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint." + }, + "SearchServiceProperties": { + "type": "object", + "properties": { + "authOptions": { + "oneOf": [ + { + "$ref": "#/definitions/DataPlaneAuthOptions" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "disableLocalAuth": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "encryptionWithCmk": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionWithCmk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys." + }, + "hostingMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "default", + "highDensity" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'." + }, + "networkRuleSet": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSet" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Network specific rules that determine how the Azure Cognitive Search service may be reached." + }, + "partitionCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 12, + "default": "1" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3." + }, + "publicNetworkAccess": { + "oneOf": [ + { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method." + }, + "replicaCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 12, + "default": "1" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU." + } + }, + "description": "Properties of the search service." + }, + "searchServices_privateEndpointConnections_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2022-09-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service." + }, + "type": { + "type": "string", + "enum": [ + "privateEndpointConnections" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Search/searchServices/privateEndpointConnections" + }, + "searchServices_sharedPrivateLinkResources_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2022-09-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service." + }, + "type": { + "type": "string", + "enum": [ + "sharedPrivateLinkResources" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Search/searchServices/sharedPrivateLinkResources" + }, + "SharedPrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id from the provider of resource the shared private link resource is for." + }, + "privateLinkResourceId": { + "type": "string", + "description": "The resource id of the resource the shared private link resource is for." + }, + "provisioningState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Updating", + "Deleting", + "Failed", + "Succeeded", + "Incomplete" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete." + }, + "requestMessage": { + "type": "string", + "description": "The request message for requesting approval of the shared private link resource." + }, + "resourceRegion": { + "type": "string", + "description": "Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service)." + }, + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected." + } + }, + "description": "Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "free", + "basic", + "standard", + "standard2", + "standard3", + "storage_optimized_l1", + "storage_optimized_l2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'." + } + }, + "description": "Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits." + } + } +} \ No newline at end of file diff --git a/schemas/common/autogeneratedResources.json b/schemas/common/autogeneratedResources.json index 74f5af2763..5733c42e2e 100644 --- a/schemas/common/autogeneratedResources.json +++ b/schemas/common/autogeneratedResources.json @@ -24058,6 +24058,15 @@ { "$ref": "https://schema.management.azure.com/schemas/2021-04-01-preview/Microsoft.Search.json#/resourceDefinitions/searchServices_sharedPrivateLinkResources" }, + { + "$ref": "https://schema.management.azure.com/schemas/2022-09-01/Microsoft.Search.json#/resourceDefinitions/searchServices" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2022-09-01/Microsoft.Search.json#/resourceDefinitions/searchServices_privateEndpointConnections" + }, + { + "$ref": "https://schema.management.azure.com/schemas/2022-09-01/Microsoft.Search.json#/resourceDefinitions/searchServices_sharedPrivateLinkResources" + }, { "$ref": "https://schema.management.azure.com/schemas/2021-01-11/Microsoft.SecurityAndCompliance.json#/resourceDefinitions/privateLinkServicesForEDMUpload" },