search.azure.com/v1api20220901
search.azure.com/v1api20220901
Package v1api20220901 contains API Schema definitions for the search v1api20220901 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2022-09-01" |
DataPlaneAadOrApiKeyAuthOption
(Appears on:DataPlaneAuthOptions)
Indicates that either the API key or an access token from Azure Active Directory can be used for authentication.
Field | Description |
---|---|
aadAuthFailureMode DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode |
AadAuthFailureMode: Describes what response the data plane API of a Search service would send for requests that failed authentication. |
DataPlaneAadOrApiKeyAuthOption_ARM
(Appears on:DataPlaneAuthOptions_ARM)
Indicates that either the API key or an access token from Azure Active Directory can be used for authentication.
Field | Description |
---|---|
aadAuthFailureMode DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode_ARM |
AadAuthFailureMode: Describes what response the data plane API of a Search service would send for requests that failed authentication. |
DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode
(string
alias)
(Appears on:DataPlaneAadOrApiKeyAuthOption)
Value | Description |
---|---|
"http401WithBearerChallenge" |
|
"http403" |
DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode_ARM
(string
alias)
(Appears on:DataPlaneAadOrApiKeyAuthOption_ARM)
Value | Description |
---|---|
"http401WithBearerChallenge" |
|
"http403" |
DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode_STATUS
(string
alias)
(Appears on:DataPlaneAadOrApiKeyAuthOption_STATUS)
Value | Description |
---|---|
"http401WithBearerChallenge" |
|
"http403" |
DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode_STATUS_ARM
(string
alias)
(Appears on:DataPlaneAadOrApiKeyAuthOption_STATUS_ARM)
Value | Description |
---|---|
"http401WithBearerChallenge" |
|
"http403" |
DataPlaneAadOrApiKeyAuthOption_STATUS
(Appears on:DataPlaneAuthOptions_STATUS)
Indicates that either the API key or an access token from Azure Active Directory can be used for authentication.
Field | Description |
---|---|
aadAuthFailureMode DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode_STATUS |
AadAuthFailureMode: Describes what response the data plane API of a Search service would send for requests that failed authentication. |
DataPlaneAadOrApiKeyAuthOption_STATUS_ARM
(Appears on:DataPlaneAuthOptions_STATUS_ARM)
Indicates that either the API key or an access token from Azure Active Directory can be used for authentication.
Field | Description |
---|---|
aadAuthFailureMode DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode_STATUS_ARM |
AadAuthFailureMode: Describes what response the data plane API of a Search service would send for requests that failed authentication. |
DataPlaneAuthOptions
(Appears on:SearchService_Spec)
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.
Field | Description |
---|---|
aadOrApiKey DataPlaneAadOrApiKeyAuthOption |
AadOrApiKey: Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. |
DataPlaneAuthOptions_ARM
(Appears on:SearchServiceProperties_ARM)
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.
Field | Description |
---|---|
aadOrApiKey DataPlaneAadOrApiKeyAuthOption_ARM |
AadOrApiKey: Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. |
DataPlaneAuthOptions_STATUS
(Appears on:SearchService_STATUS)
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.
Field | Description |
---|---|
aadOrApiKey DataPlaneAadOrApiKeyAuthOption_STATUS |
AadOrApiKey: Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. |
apiKeyOnly map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
ApiKeyOnly: Indicates that only the API key needs to be used for authentication. |
DataPlaneAuthOptions_STATUS_ARM
(Appears on:SearchServiceProperties_STATUS_ARM)
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.
Field | Description |
---|---|
aadOrApiKey DataPlaneAadOrApiKeyAuthOption_STATUS_ARM |
AadOrApiKey: Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. |
apiKeyOnly map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
ApiKeyOnly: Indicates that only the API key needs to be used for authentication. |
EncryptionWithCmk
(Appears on:SearchService_Spec)
Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys.
Field | Description |
---|---|
enforcement EncryptionWithCmk_Enforcement |
Enforcement: Describes how a search service should enforce having one or more non customer encrypted resources. |
EncryptionWithCmk_ARM
(Appears on:SearchServiceProperties_ARM)
Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys.
Field | Description |
---|---|
enforcement EncryptionWithCmk_Enforcement_ARM |
Enforcement: Describes how a search service should enforce having one or more non customer encrypted resources. |
EncryptionWithCmk_EncryptionComplianceStatus_STATUS
(string
alias)
(Appears on:EncryptionWithCmk_STATUS)
Value | Description |
---|---|
"Compliant" |
|
"NonCompliant" |
EncryptionWithCmk_EncryptionComplianceStatus_STATUS_ARM
(string
alias)
(Appears on:EncryptionWithCmk_STATUS_ARM)
Value | Description |
---|---|
"Compliant" |
|
"NonCompliant" |
EncryptionWithCmk_Enforcement
(string
alias)
(Appears on:EncryptionWithCmk)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"Unspecified" |
EncryptionWithCmk_Enforcement_ARM
(string
alias)
(Appears on:EncryptionWithCmk_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"Unspecified" |
EncryptionWithCmk_Enforcement_STATUS
(string
alias)
(Appears on:EncryptionWithCmk_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"Unspecified" |
EncryptionWithCmk_Enforcement_STATUS_ARM
(string
alias)
(Appears on:EncryptionWithCmk_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"Unspecified" |
EncryptionWithCmk_STATUS
(Appears on:SearchService_STATUS)
Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys.
Field | Description |
---|---|
encryptionComplianceStatus EncryptionWithCmk_EncryptionComplianceStatus_STATUS |
EncryptionComplianceStatus: 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’. |
enforcement EncryptionWithCmk_Enforcement_STATUS |
Enforcement: Describes how a search service should enforce having one or more non customer encrypted resources. |
EncryptionWithCmk_STATUS_ARM
(Appears on:SearchServiceProperties_STATUS_ARM)
Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys.
Field | Description |
---|---|
encryptionComplianceStatus EncryptionWithCmk_EncryptionComplianceStatus_STATUS_ARM |
EncryptionComplianceStatus: 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’. |
enforcement EncryptionWithCmk_Enforcement_STATUS_ARM |
Enforcement: Describes how a search service should enforce having one or more non customer encrypted resources. |
Identity
(Appears on:SearchService_Spec)
Identity for the resource.
Field | Description |
---|---|
type Identity_Type |
Type: The identity type. |
Identity_ARM
(Appears on:SearchService_Spec_ARM)
Identity for the resource.
Field | Description |
---|---|
type Identity_Type_ARM |
Type: The identity type. |
Identity_STATUS
(Appears on:SearchService_STATUS)
Identity for the resource.
Field | Description |
---|---|
principalId string |
PrincipalId: The principal ID of the system-assigned identity of the search service. |
tenantId string |
TenantId: The tenant ID of the system-assigned identity of the search service. |
type Identity_Type_STATUS |
Type: The identity type. |
Identity_STATUS_ARM
(Appears on:SearchService_STATUS_ARM)
Identity for the resource.
Field | Description |
---|---|
principalId string |
PrincipalId: The principal ID of the system-assigned identity of the search service. |
tenantId string |
TenantId: The tenant ID of the system-assigned identity of the search service. |
type Identity_Type_STATUS_ARM |
Type: The identity type. |
Identity_Type
(string
alias)
(Appears on:Identity)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
Identity_Type_ARM
(string
alias)
(Appears on:Identity_ARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
Identity_Type_STATUS
(string
alias)
(Appears on:Identity_STATUS)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
Identity_Type_STATUS_ARM
(string
alias)
(Appears on:Identity_STATUS_ARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
IpRule
(Appears on:NetworkRuleSet)
The IP restriction rule of the Azure Cognitive Search service.
Field | Description |
---|---|
value string |
Value: 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. |
IpRule_ARM
(Appears on:NetworkRuleSet_ARM)
The IP restriction rule of the Azure Cognitive Search service.
Field | Description |
---|---|
value string |
Value: 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. |
IpRule_STATUS
(Appears on:NetworkRuleSet_STATUS)
The IP restriction rule of the Azure Cognitive Search service.
Field | Description |
---|---|
value string |
Value: 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. |
IpRule_STATUS_ARM
(Appears on:NetworkRuleSet_STATUS_ARM)
The IP restriction rule of the Azure Cognitive Search service.
Field | Description |
---|---|
value string |
Value: 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. |
NetworkRuleSet
(Appears on:SearchService_Spec)
Network specific rules that determine how the Azure Cognitive Search service may be reached.
Field | Description |
---|---|
ipRules []IpRule |
IpRules: 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. |
NetworkRuleSet_ARM
(Appears on:SearchServiceProperties_ARM)
Network specific rules that determine how the Azure Cognitive Search service may be reached.
Field | Description |
---|---|
ipRules []IpRule_ARM |
IpRules: 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. |
NetworkRuleSet_STATUS
(Appears on:SearchService_STATUS)
Network specific rules that determine how the Azure Cognitive Search service may be reached.
Field | Description |
---|---|
ipRules []IpRule_STATUS |
IpRules: 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. |
NetworkRuleSet_STATUS_ARM
(Appears on:SearchServiceProperties_STATUS_ARM)
Network specific rules that determine how the Azure Cognitive Search service may be reached.
Field | Description |
---|---|
ipRules []IpRule_STATUS_ARM |
IpRules: 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. |
PrivateEndpointConnection_STATUS
(Appears on:SearchService_STATUS)
Describes an existing Private Endpoint connection to the Azure Cognitive Search service.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
PrivateEndpointConnection_STATUS_ARM
(Appears on:SearchServiceProperties_STATUS_ARM)
Describes an existing Private Endpoint connection to the Azure Cognitive Search service.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
SearchService
Generator information: - Generated from: /search/resource-manager/Microsoft.Search/stable/2022-09-01/search.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}p>
Field | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||
spec SearchService_Spec |
|
||||||||||||||||||||||||||||||
status SearchService_STATUS |
SearchServiceOperatorSecrets
(Appears on:SearchServiceOperatorSpec)
Field | Description |
---|---|
adminPrimaryKey genruntime.SecretDestination |
AdminPrimaryKey: indicates where the AdminPrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
adminSecondaryKey genruntime.SecretDestination |
AdminSecondaryKey: indicates where the AdminSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
queryKey genruntime.SecretDestination |
QueryKey: indicates where the QueryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
SearchServiceOperatorSpec
(Appears on:SearchService_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
secrets SearchServiceOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
SearchServiceProperties_ARM
(Appears on:SearchService_Spec_ARM)
Properties of the search service.
Field | Description |
---|---|
authOptions DataPlaneAuthOptions_ARM |
AuthOptions: 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 bool |
DisableLocalAuth: 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 EncryptionWithCmk_ARM |
EncryptionWithCmk: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. |
hostingMode SearchServiceProperties_HostingMode_ARM |
HostingMode: 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 NetworkRuleSet_ARM |
NetworkRuleSet: Network specific rules that determine how the Azure Cognitive Search service may be reached. |
partitionCount int |
PartitionCount: 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 SearchServiceProperties_PublicNetworkAccess_ARM |
PublicNetworkAccess: 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 int |
ReplicaCount: 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. |
SearchServiceProperties_HostingMode
(string
alias)
(Appears on:SearchService_Spec)
Value | Description |
---|---|
"default" |
|
"highDensity" |
SearchServiceProperties_HostingMode_ARM
(string
alias)
(Appears on:SearchServiceProperties_ARM)
Value | Description |
---|---|
"default" |
|
"highDensity" |
SearchServiceProperties_HostingMode_STATUS
(string
alias)
(Appears on:SearchService_STATUS)
Value | Description |
---|---|
"default" |
|
"highDensity" |
SearchServiceProperties_HostingMode_STATUS_ARM
(string
alias)
(Appears on:SearchServiceProperties_STATUS_ARM)
Value | Description |
---|---|
"default" |
|
"highDensity" |
SearchServiceProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:SearchService_STATUS)
Value | Description |
---|---|
"failed" |
|
"provisioning" |
|
"succeeded" |
SearchServiceProperties_ProvisioningState_STATUS_ARM
(string
alias)
(Appears on:SearchServiceProperties_STATUS_ARM)
Value | Description |
---|---|
"failed" |
|
"provisioning" |
|
"succeeded" |
SearchServiceProperties_PublicNetworkAccess
(string
alias)
(Appears on:SearchService_Spec)
Value | Description |
---|---|
"disabled" |
|
"enabled" |
SearchServiceProperties_PublicNetworkAccess_ARM
(string
alias)
(Appears on:SearchServiceProperties_ARM)
Value | Description |
---|---|
"disabled" |
|
"enabled" |
SearchServiceProperties_PublicNetworkAccess_STATUS
(string
alias)
(Appears on:SearchService_STATUS)
Value | Description |
---|---|
"disabled" |
|
"enabled" |
SearchServiceProperties_PublicNetworkAccess_STATUS_ARM
(string
alias)
(Appears on:SearchServiceProperties_STATUS_ARM)
Value | Description |
---|---|
"disabled" |
|
"enabled" |
SearchServiceProperties_STATUS_ARM
(Appears on:SearchService_STATUS_ARM)
Properties of the search service.
Field | Description |
---|---|
authOptions DataPlaneAuthOptions_STATUS_ARM |
AuthOptions: 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 bool |
DisableLocalAuth: 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 EncryptionWithCmk_STATUS_ARM |
EncryptionWithCmk: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. |
hostingMode SearchServiceProperties_HostingMode_STATUS_ARM |
HostingMode: 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 NetworkRuleSet_STATUS_ARM |
NetworkRuleSet: Network specific rules that determine how the Azure Cognitive Search service may be reached. |
partitionCount int |
PartitionCount: 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. |
privateEndpointConnections []PrivateEndpointConnection_STATUS_ARM |
PrivateEndpointConnections: The list of private endpoint connections to the Azure Cognitive Search service. |
provisioningState SearchServiceProperties_ProvisioningState_STATUS_ARM |
ProvisioningState: The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either ‘succeeded’ or ‘failed’. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as ‘succeeded’ directly in the call to Create search service. This is because the free service uses capacity that is already set up. |
publicNetworkAccess SearchServiceProperties_PublicNetworkAccess_STATUS_ARM |
PublicNetworkAccess: 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 int |
ReplicaCount: 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. |
sharedPrivateLinkResources []SharedPrivateLinkResource_STATUS_ARM |
SharedPrivateLinkResources: The list of shared private link resources managed by the Azure Cognitive Search service. |
status SearchServiceProperties_Status_STATUS_ARM |
Status: The status of the search service. Possible values include: ‘running’: The search service is running and no provisioning operations are underway. ‘provisioning’: The search service is being provisioned or scaled up or down. ‘deleting’: The search service is being deleted. ‘degraded’: The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. ‘disabled’: The search service is disabled. In this state, the service will reject all API requests. ‘error’: The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. |
statusDetails string |
StatusDetails: The details of the search service status. |
SearchServiceProperties_Status_STATUS
(string
alias)
(Appears on:SearchService_STATUS)
Value | Description |
---|---|
"degraded" |
|
"deleting" |
|
"disabled" |
|
"error" |
|
"provisioning" |
|
"running" |
SearchServiceProperties_Status_STATUS_ARM
(string
alias)
(Appears on:SearchServiceProperties_STATUS_ARM)
Value | Description |
---|---|
"degraded" |
|
"deleting" |
|
"disabled" |
|
"error" |
|
"provisioning" |
|
"running" |
SearchService_STATUS
(Appears on:SearchService)
Describes an Azure Cognitive Search service and its current state.
Field | Description |
---|---|
authOptions DataPlaneAuthOptions_STATUS |
AuthOptions: 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. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
disableLocalAuth bool |
DisableLocalAuth: 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 EncryptionWithCmk_STATUS |
EncryptionWithCmk: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. |
hostingMode SearchServiceProperties_HostingMode_STATUS |
HostingMode: 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’. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_STATUS |
Identity: The identity of the resource. |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
networkRuleSet NetworkRuleSet_STATUS |
NetworkRuleSet: Network specific rules that determine how the Azure Cognitive Search service may be reached. |
partitionCount int |
PartitionCount: 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. |
privateEndpointConnections []PrivateEndpointConnection_STATUS |
PrivateEndpointConnections: The list of private endpoint connections to the Azure Cognitive Search service. |
provisioningState SearchServiceProperties_ProvisioningState_STATUS |
ProvisioningState: The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either ‘succeeded’ or ‘failed’. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as ‘succeeded’ directly in the call to Create search service. This is because the free service uses capacity that is already set up. |
publicNetworkAccess SearchServiceProperties_PublicNetworkAccess_STATUS |
PublicNetworkAccess: 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 int |
ReplicaCount: 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. |
sharedPrivateLinkResources []SharedPrivateLinkResource_STATUS |
SharedPrivateLinkResources: The list of shared private link resources managed by the Azure Cognitive Search service. |
sku Sku_STATUS |
Sku: The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. |
status SearchServiceProperties_Status_STATUS |
Status: The status of the search service. Possible values include: ‘running’: The search service is running and no provisioning operations are underway. ‘provisioning’: The search service is being provisioned or scaled up or down. ‘deleting’: The search service is being deleted. ‘degraded’: The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. ‘disabled’: The search service is disabled. In this state, the service will reject all API requests. ‘error’: The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. |
statusDetails string |
StatusDetails: The details of the search service status. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
SearchService_STATUS_ARM
Describes an Azure Cognitive Search service and its current state.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_STATUS_ARM |
Identity: The identity of the resource. |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
properties SearchServiceProperties_STATUS_ARM |
Properties: Properties of the search service. |
sku Sku_STATUS_ARM |
Sku: The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
SearchService_Spec
(Appears on:SearchService)
Field | Description |
---|---|
authOptions DataPlaneAuthOptions |
AuthOptions: 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. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
disableLocalAuth bool |
DisableLocalAuth: 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 EncryptionWithCmk |
EncryptionWithCmk: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. |
hostingMode SearchServiceProperties_HostingMode |
HostingMode: 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’. |
identity Identity |
Identity: The identity of the resource. |
location string |
Location: The geo-location where the resource lives |
networkRuleSet NetworkRuleSet |
NetworkRuleSet: Network specific rules that determine how the Azure Cognitive Search service may be reached. |
operatorSpec SearchServiceOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
partitionCount int |
PartitionCount: 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 SearchServiceProperties_PublicNetworkAccess |
PublicNetworkAccess: 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 int |
ReplicaCount: 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. |
sku Sku |
Sku: The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. |
tags map[string]string |
Tags: Resource tags. |
SearchService_Spec_ARM
Field | Description |
---|---|
identity Identity_ARM |
Identity: The identity of the resource. |
location string |
Location: The geo-location where the resource lives |
name string |
|
properties SearchServiceProperties_ARM |
Properties: Properties of the search service. |
sku Sku_ARM |
Sku: The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. |
tags map[string]string |
Tags: Resource tags. |
SharedPrivateLinkResource_STATUS
(Appears on:SearchService_STATUS)
Describes a Shared Private Link Resource managed by the Azure Cognitive Search service.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
SharedPrivateLinkResource_STATUS_ARM
(Appears on:SearchServiceProperties_STATUS_ARM)
Describes a Shared Private Link Resource managed by the Azure Cognitive Search service.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
Sku
(Appears on:SearchService_Spec)
Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
Field | Description |
---|---|
name Sku_Name |
Name: 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.’ |
Sku_ARM
(Appears on:SearchService_Spec_ARM)
Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
Field | Description |
---|---|
name Sku_Name_ARM |
Name: 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.’ |
Sku_Name
(string
alias)
(Appears on:Sku)
Value | Description |
---|---|
"basic" |
|
"free" |
|
"standard" |
|
"standard2" |
|
"standard3" |
|
"storage_optimized_l1" |
|
"storage_optimized_l2" |
Sku_Name_ARM
(string
alias)
(Appears on:Sku_ARM)
Value | Description |
---|---|
"basic" |
|
"free" |
|
"standard" |
|
"standard2" |
|
"standard3" |
|
"storage_optimized_l1" |
|
"storage_optimized_l2" |
Sku_Name_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"basic" |
|
"free" |
|
"standard" |
|
"standard2" |
|
"standard3" |
|
"storage_optimized_l1" |
|
"storage_optimized_l2" |
Sku_Name_STATUS_ARM
(string
alias)
(Appears on:Sku_STATUS_ARM)
Value | Description |
---|---|
"basic" |
|
"free" |
|
"standard" |
|
"standard2" |
|
"standard3" |
|
"storage_optimized_l1" |
|
"storage_optimized_l2" |
Sku_STATUS
(Appears on:SearchService_STATUS)
Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
Field | Description |
---|---|
name Sku_Name_STATUS |
Name: 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.’ |
Sku_STATUS_ARM
(Appears on:SearchService_STATUS_ARM)
Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
Field | Description |
---|---|
name Sku_Name_STATUS_ARM |
Name: 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.’ |