search.azure.com/v1api20220901
APIVersion
| Value | Description |
|---|---|
| “2022-09-01” |
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}
Used by: SearchServiceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | SearchService_Spec Optional |
|
| status | SearchService_STATUS Optional |
SearchService_Spec
| Property | Description | Type |
|---|---|---|
| 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. | DataPlaneAuthOptions Optional |
| 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. | string Optional |
| 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. | bool Optional |
| encryptionWithCmk | Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. | EncryptionWithCmk Optional |
| 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’. | SearchServiceProperties_HostingMode Optional |
| identity | The identity of the resource. | Identity Optional |
| location | The geo-location where the resource lives | string Required |
| networkRuleSet | Network specific rules that determine how the Azure Cognitive Search service may be reached. | NetworkRuleSet Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SearchServiceOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| 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. | int Optional |
| 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. | SearchServiceProperties_PublicNetworkAccess Optional |
| 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. | int Optional |
| sku | The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
SearchService_STATUS
| Property | Description | Type |
|---|---|---|
| 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. | DataPlaneAuthOptions_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| 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. | bool Optional |
| encryptionWithCmk | Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. | EncryptionWithCmk_STATUS Optional |
| 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’. | SearchServiceProperties_HostingMode_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The identity of the resource. | Identity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| networkRuleSet | Network specific rules that determine how the Azure Cognitive Search service may be reached. | NetworkRuleSet_STATUS Optional |
| 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. | int Optional |
| privateEndpointConnections | The list of private endpoint connections to the Azure Cognitive Search service. | PrivateEndpointConnection_STATUS[] Optional |
| 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. | SearchServiceProperties_ProvisioningState_STATUS Optional |
| 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. | SearchServiceProperties_PublicNetworkAccess_STATUS Optional |
| 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. | int Optional |
| sharedPrivateLinkResources | The list of shared private link resources managed by the Azure Cognitive Search service. | SharedPrivateLinkResource_STATUS[] Optional |
| sku | The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. | Sku_STATUS Optional |
| 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. | SearchServiceProperties_Status_STATUS Optional |
| statusDetails | The details of the search service status. | string Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
SearchServiceList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | SearchService[] Optional |
SearchService_Spec
Used by: SearchService.
| Property | Description | Type |
|---|---|---|
| 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. | DataPlaneAuthOptions Optional |
| 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. | string Optional |
| 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. | bool Optional |
| encryptionWithCmk | Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. | EncryptionWithCmk Optional |
| 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’. | SearchServiceProperties_HostingMode Optional |
| identity | The identity of the resource. | Identity Optional |
| location | The geo-location where the resource lives | string Required |
| networkRuleSet | Network specific rules that determine how the Azure Cognitive Search service may be reached. | NetworkRuleSet Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SearchServiceOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| 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. | int Optional |
| 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. | SearchServiceProperties_PublicNetworkAccess Optional |
| 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. | int Optional |
| sku | The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
SearchService_STATUS
Describes an Azure Cognitive Search service and its current state.
Used by: SearchService.
| Property | Description | Type |
|---|---|---|
| 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. | DataPlaneAuthOptions_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| 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. | bool Optional |
| encryptionWithCmk | Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. | EncryptionWithCmk_STATUS Optional |
| 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’. | SearchServiceProperties_HostingMode_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The identity of the resource. | Identity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| networkRuleSet | Network specific rules that determine how the Azure Cognitive Search service may be reached. | NetworkRuleSet_STATUS Optional |
| 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. | int Optional |
| privateEndpointConnections | The list of private endpoint connections to the Azure Cognitive Search service. | PrivateEndpointConnection_STATUS[] Optional |
| 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. | SearchServiceProperties_ProvisioningState_STATUS Optional |
| 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. | SearchServiceProperties_PublicNetworkAccess_STATUS Optional |
| 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. | int Optional |
| sharedPrivateLinkResources | The list of shared private link resources managed by the Azure Cognitive Search service. | SharedPrivateLinkResource_STATUS[] Optional |
| sku | The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. | Sku_STATUS Optional |
| 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. | SearchServiceProperties_Status_STATUS Optional |
| statusDetails | The details of the search service status. | string Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
DataPlaneAuthOptions
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.
Used by: SearchService_Spec.
| Property | Description | Type |
|---|---|---|
| aadOrApiKey | Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. | DataPlaneAadOrApiKeyAuthOption Optional |
DataPlaneAuthOptions_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.
Used by: SearchService_STATUS.
| Property | Description | Type |
|---|---|---|
| aadOrApiKey | Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. | DataPlaneAadOrApiKeyAuthOption_STATUS Optional |
| apiKeyOnly | Indicates that only the API key needs to be used for authentication. | map[string]v1.JSON Optional |
EncryptionWithCmk
Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys.
Used by: SearchService_Spec.
| Property | Description | Type |
|---|---|---|
| enforcement | Describes how a search service should enforce having one or more non customer encrypted resources. | EncryptionWithCmk_Enforcement Optional |
EncryptionWithCmk_STATUS
Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys.
Used by: SearchService_STATUS.
| Property | Description | Type |
|---|---|---|
| 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’. | EncryptionWithCmk_EncryptionComplianceStatus_STATUS Optional |
| enforcement | Describes how a search service should enforce having one or more non customer encrypted resources. | EncryptionWithCmk_Enforcement_STATUS Optional |
Identity
Identity for the resource.
Used by: SearchService_Spec.
| Property | Description | Type |
|---|---|---|
| type | The identity type. | Identity_Type Required |
Identity_STATUS
Identity for the resource.
Used by: SearchService_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal ID of the system-assigned identity of the search service. | string Optional |
| tenantId | The tenant ID of the system-assigned identity of the search service. | string Optional |
| type | The identity type. | Identity_Type_STATUS Optional |
NetworkRuleSet
Network specific rules that determine how the Azure Cognitive Search service may be reached.
Used by: SearchService_Spec.
| Property | Description | Type |
|---|---|---|
| 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. | IpRule[] Optional |
NetworkRuleSet_STATUS
Network specific rules that determine how the Azure Cognitive Search service may be reached.
Used by: SearchService_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | IpRule_STATUS[] Optional |
PrivateEndpointConnection_STATUS
Describes an existing Private Endpoint connection to the Azure Cognitive Search service.
Used by: SearchService_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
SearchServiceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: SearchService_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | SearchServiceOperatorSecrets Optional |
SearchServiceProperties_HostingMode
Used by: SearchService_Spec.
| Value | Description |
|---|---|
| “default” | |
| “highDensity” |
SearchServiceProperties_HostingMode_STATUS
Used by: SearchService_STATUS.
| Value | Description |
|---|---|
| “default” | |
| “highDensity” |
SearchServiceProperties_ProvisioningState_STATUS
Used by: SearchService_STATUS.
| Value | Description |
|---|---|
| “failed” | |
| “provisioning” | |
| “succeeded” |
SearchServiceProperties_PublicNetworkAccess
Used by: SearchService_Spec.
| Value | Description |
|---|---|
| “disabled” | |
| “enabled” |
SearchServiceProperties_PublicNetworkAccess_STATUS
Used by: SearchService_STATUS.
| Value | Description |
|---|---|
| “disabled” | |
| “enabled” |
SearchServiceProperties_Status_STATUS
Used by: SearchService_STATUS.
| Value | Description |
|---|---|
| “degraded” | |
| “deleting” | |
| “disabled” | |
| “error” | |
| “provisioning” | |
| “running” |
SharedPrivateLinkResource_STATUS
Describes a Shared Private Link Resource managed by the Azure Cognitive Search service.
Used by: SearchService_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
Sku
Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
Used by: SearchService_Spec.
| Property | Description | Type |
|---|---|---|
| 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 Optional |
Sku_STATUS
Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
Used by: SearchService_STATUS.
| Property | Description | Type |
|---|---|---|
| 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_STATUS Optional |
DataPlaneAadOrApiKeyAuthOption
Indicates that either the API key or an access token from Azure Active Directory can be used for authentication.
Used by: DataPlaneAuthOptions.
| Property | Description | Type |
|---|---|---|
| aadAuthFailureMode | Describes what response the data plane API of a Search service would send for requests that failed authentication. | DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode Optional |
DataPlaneAadOrApiKeyAuthOption_STATUS
Indicates that either the API key or an access token from Azure Active Directory can be used for authentication.
Used by: DataPlaneAuthOptions_STATUS.
| Property | Description | Type |
|---|---|---|
| aadAuthFailureMode | Describes what response the data plane API of a Search service would send for requests that failed authentication. | DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode_STATUS Optional |
EncryptionWithCmk_EncryptionComplianceStatus_STATUS
Used by: EncryptionWithCmk_STATUS.
| Value | Description |
|---|---|
| “Compliant” | |
| “NonCompliant” |
EncryptionWithCmk_Enforcement
Used by: EncryptionWithCmk.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “Unspecified” |
EncryptionWithCmk_Enforcement_STATUS
Used by: EncryptionWithCmk_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “Unspecified” |
Identity_Type
Used by: Identity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” |
Identity_Type_STATUS
Used by: Identity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” |
IpRule
The IP restriction rule of the Azure Cognitive Search service.
Used by: NetworkRuleSet.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
IpRule_STATUS
The IP restriction rule of the Azure Cognitive Search service.
Used by: NetworkRuleSet_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
SearchServiceOperatorSecrets
Used by: SearchServiceOperatorSpec.
| Property | Description | Type |
|---|---|---|
| adminPrimaryKey | indicates where the AdminPrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| adminSecondaryKey | indicates where the AdminSecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| queryKey | indicates where the QueryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
Sku_Name
Used by: Sku.
| Value | Description |
|---|---|
| “basic” | |
| “free” | |
| “standard” | |
| “standard2” | |
| “standard3” | |
| “storage_optimized_l1” | |
| “storage_optimized_l2” |
Sku_Name_STATUS
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “basic” | |
| “free” | |
| “standard” | |
| “standard2” | |
| “standard3” | |
| “storage_optimized_l1” | |
| “storage_optimized_l2” |
DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode
Used by: DataPlaneAadOrApiKeyAuthOption.
| Value | Description |
|---|---|
| “http401WithBearerChallenge” | |
| “http403” |
DataPlaneAadOrApiKeyAuthOption_AadAuthFailureMode_STATUS
Used by: DataPlaneAadOrApiKeyAuthOption_STATUS.
| Value | Description |
|---|---|
| “http401WithBearerChallenge” | |
| “http403” |