Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. search
  5. getService
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.search.getService

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the search service with the given name in the given resource group.

    Uses Azure REST API version 2025-05-01.

    Other available API versions: 2022-09-01, 2023-11-01, 2024-03-01-preview, 2024-06-01-preview, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native search [ApiVersion]. See the version guide for details.

    Using getService

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
    def get_service(resource_group_name: Optional[str] = None,
                search_service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                search_service_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
    func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

    > Note: This function is named LookupService in the Go SDK.

    public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:search:getService
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    SearchServiceName string
    The name of the Azure AI Search service associated with the specified resource group.
    ResourceGroupName string
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    SearchServiceName string
    The name of the Azure AI Search service associated with the specified resource group.
    resourceGroupName String
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    searchServiceName String
    The name of the Azure AI Search service associated with the specified resource group.
    resourceGroupName string
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    searchServiceName string
    The name of the Azure AI Search service associated with the specified resource group.
    resource_group_name str
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    search_service_name str
    The name of the Azure AI Search service associated with the specified resource group.
    resourceGroupName String
    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
    searchServiceName String
    The name of the Azure AI Search service associated with the specified resource group.

    getService Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ETag string
    A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PrivateEndpointConnections List<Pulumi.AzureNative.Search.Outputs.PrivateEndpointConnectionResponse>
    The list of private endpoint connections to the Azure AI Search service.
    ProvisioningState string
    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.
    ServiceUpgradedAt string
    The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.
    SharedPrivateLinkResources List<Pulumi.AzureNative.Search.Outputs.SharedPrivateLinkResourceResponse>
    The list of shared private link resources managed by the Azure AI Search service.
    Status string
    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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI 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
    The details of the search service status.
    SystemData Pulumi.AzureNative.Search.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AuthOptions Pulumi.AzureNative.Search.Outputs.DataPlaneAuthOptionsResponse
    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.
    ComputeType string
    Configure this property to support the search service using either the Default Compute or Azure Confidential Compute.
    DataExfiltrationProtections List<string>
    A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
    DisableLocalAuth bool
    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 Pulumi.AzureNative.Search.Outputs.EncryptionWithCmkResponse
    Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
    Endpoint string
    The endpoint of the Azure AI Search service.
    HostingMode string
    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 Pulumi.AzureNative.Search.Outputs.IdentityResponse
    The identity of the resource.
    NetworkRuleSet Pulumi.AzureNative.Search.Outputs.NetworkRuleSetResponse
    Network specific rules that determine how the Azure AI Search service may be reached.
    PartitionCount int
    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 string
    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
    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.
    SemanticSearch string
    Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
    Sku Pulumi.AzureNative.Search.Outputs.SkuResponse
    The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.
    Tags Dictionary<string, string>
    Resource tags.
    UpgradeAvailable string
    Indicates if the search service has an upgrade available.
    AzureApiVersion string
    The Azure API version of the resource.
    ETag string
    A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    The list of private endpoint connections to the Azure AI Search service.
    ProvisioningState string
    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.
    ServiceUpgradedAt string
    The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.
    SharedPrivateLinkResources []SharedPrivateLinkResourceResponse
    The list of shared private link resources managed by the Azure AI Search service.
    Status string
    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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI 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
    The details of the search service status.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AuthOptions DataPlaneAuthOptionsResponse
    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.
    ComputeType string
    Configure this property to support the search service using either the Default Compute or Azure Confidential Compute.
    DataExfiltrationProtections []string
    A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
    DisableLocalAuth bool
    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 EncryptionWithCmkResponse
    Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
    Endpoint string
    The endpoint of the Azure AI Search service.
    HostingMode string
    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 IdentityResponse
    The identity of the resource.
    NetworkRuleSet NetworkRuleSetResponse
    Network specific rules that determine how the Azure AI Search service may be reached.
    PartitionCount int
    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 string
    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
    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.
    SemanticSearch string
    Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
    Sku SkuResponse
    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
    Resource tags.
    UpgradeAvailable string
    Indicates if the search service has an upgrade available.
    azureApiVersion String
    The Azure API version of the resource.
    eTag String
    A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    The list of private endpoint connections to the Azure AI Search service.
    provisioningState String
    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.
    serviceUpgradedAt String
    The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.
    sharedPrivateLinkResources List<SharedPrivateLinkResourceResponse>
    The list of shared private link resources managed by the Azure AI Search service.
    status String
    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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI 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
    The details of the search service status.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    authOptions DataPlaneAuthOptionsResponse
    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.
    computeType String
    Configure this property to support the search service using either the Default Compute or Azure Confidential Compute.
    dataExfiltrationProtections List<String>
    A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
    disableLocalAuth Boolean
    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 EncryptionWithCmkResponse
    Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
    endpoint String
    The endpoint of the Azure AI Search service.
    hostingMode String
    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 IdentityResponse
    The identity of the resource.
    networkRuleSet NetworkRuleSetResponse
    Network specific rules that determine how the Azure AI Search service may be reached.
    partitionCount Integer
    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 String
    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 Integer
    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.
    semanticSearch String
    Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
    sku SkuResponse
    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>
    Resource tags.
    upgradeAvailable String
    Indicates if the search service has an upgrade available.
    azureApiVersion string
    The Azure API version of the resource.
    eTag string
    A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    The list of private endpoint connections to the Azure AI Search service.
    provisioningState string
    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.
    serviceUpgradedAt string
    The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.
    sharedPrivateLinkResources SharedPrivateLinkResourceResponse[]
    The list of shared private link resources managed by the Azure AI Search service.
    status string
    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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI 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
    The details of the search service status.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    authOptions DataPlaneAuthOptionsResponse
    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.
    computeType string
    Configure this property to support the search service using either the Default Compute or Azure Confidential Compute.
    dataExfiltrationProtections string[]
    A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
    disableLocalAuth boolean
    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 EncryptionWithCmkResponse
    Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
    endpoint string
    The endpoint of the Azure AI Search service.
    hostingMode string
    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 IdentityResponse
    The identity of the resource.
    networkRuleSet NetworkRuleSetResponse
    Network specific rules that determine how the Azure AI Search service may be reached.
    partitionCount number
    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 string
    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 number
    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.
    semanticSearch string
    Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
    sku SkuResponse
    The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.
    tags {[key: string]: string}
    Resource tags.
    upgradeAvailable string
    Indicates if the search service has an upgrade available.
    azure_api_version str
    The Azure API version of the resource.
    e_tag str
    A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    The list of private endpoint connections to the Azure AI Search service.
    provisioning_state str
    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.
    service_upgraded_at str
    The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.
    shared_private_link_resources Sequence[SharedPrivateLinkResourceResponse]
    The list of shared private link resources managed by the Azure AI Search service.
    status str
    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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
    status_details str
    The details of the search service status.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    auth_options DataPlaneAuthOptionsResponse
    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.
    compute_type str
    Configure this property to support the search service using either the Default Compute or Azure Confidential Compute.
    data_exfiltration_protections Sequence[str]
    A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
    disable_local_auth bool
    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.
    encryption_with_cmk EncryptionWithCmkResponse
    Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
    endpoint str
    The endpoint of the Azure AI Search service.
    hosting_mode str
    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 IdentityResponse
    The identity of the resource.
    network_rule_set NetworkRuleSetResponse
    Network specific rules that determine how the Azure AI Search service may be reached.
    partition_count int
    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.
    public_network_access str
    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.
    replica_count int
    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.
    semantic_search str
    Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
    sku SkuResponse
    The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.
    tags Mapping[str, str]
    Resource tags.
    upgrade_available str
    Indicates if the search service has an upgrade available.
    azureApiVersion String
    The Azure API version of the resource.
    eTag String
    A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    privateEndpointConnections List<Property Map>
    The list of private endpoint connections to the Azure AI Search service.
    provisioningState String
    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.
    serviceUpgradedAt String
    The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.
    sharedPrivateLinkResources List<Property Map>
    The list of shared private link resources managed by the Azure AI Search service.
    status String
    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. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI 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
    The details of the search service status.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    authOptions Property Map
    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.
    computeType String
    Configure this property to support the search service using either the Default Compute or Azure Confidential Compute.
    dataExfiltrationProtections List<String>
    A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
    disableLocalAuth Boolean
    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 Property Map
    Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
    endpoint String
    The endpoint of the Azure AI Search service.
    hostingMode String
    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 Property Map
    The identity of the resource.
    networkRuleSet Property Map
    Network specific rules that determine how the Azure AI Search service may be reached.
    partitionCount Number
    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 String
    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 Number
    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.
    semanticSearch String
    Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
    sku Property Map
    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>
    Resource tags.
    upgradeAvailable String
    Indicates if the search service has an upgrade available.

    Supporting Types

    DataPlaneAadOrApiKeyAuthOptionResponse

    AadAuthFailureMode string
    Describes what response the data plane API of a search service would send for requests that failed authentication.
    AadAuthFailureMode string
    Describes what response the data plane API of a search service would send for requests that failed authentication.
    aadAuthFailureMode String
    Describes what response the data plane API of a search service would send for requests that failed authentication.
    aadAuthFailureMode string
    Describes what response the data plane API of a search service would send for requests that failed authentication.
    aad_auth_failure_mode str
    Describes what response the data plane API of a search service would send for requests that failed authentication.
    aadAuthFailureMode String
    Describes what response the data plane API of a search service would send for requests that failed authentication.

    DataPlaneAuthOptionsResponse

    AadOrApiKey Pulumi.AzureNative.Search.Inputs.DataPlaneAadOrApiKeyAuthOptionResponse
    Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
    ApiKeyOnly object
    Indicates that only the API key can be used for authentication.
    AadOrApiKey DataPlaneAadOrApiKeyAuthOptionResponse
    Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
    ApiKeyOnly interface{}
    Indicates that only the API key can be used for authentication.
    aadOrApiKey DataPlaneAadOrApiKeyAuthOptionResponse
    Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
    apiKeyOnly Object
    Indicates that only the API key can be used for authentication.
    aadOrApiKey DataPlaneAadOrApiKeyAuthOptionResponse
    Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
    apiKeyOnly any
    Indicates that only the API key can be used for authentication.
    aad_or_api_key DataPlaneAadOrApiKeyAuthOptionResponse
    Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
    api_key_only Any
    Indicates that only the API key can be used for authentication.
    aadOrApiKey Property Map
    Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
    apiKeyOnly Any
    Indicates that only the API key can be used for authentication.

    EncryptionWithCmkResponse

    EncryptionComplianceStatus string
    Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
    Enforcement string
    Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.
    EncryptionComplianceStatus string
    Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
    Enforcement string
    Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.
    encryptionComplianceStatus String
    Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
    enforcement String
    Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.
    encryptionComplianceStatus string
    Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
    enforcement string
    Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.
    encryption_compliance_status str
    Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
    enforcement str
    Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.
    encryptionComplianceStatus String
    Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
    enforcement String
    Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.

    IdentityResponse

    PrincipalId string
    The principal ID of the system-assigned identity of the search service.
    TenantId string
    The tenant ID of the system-assigned identity of the search service.
    Type string
    The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Search.Inputs.UserAssignedIdentityResponse>
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    PrincipalId string
    The principal ID of the system-assigned identity of the search service.
    TenantId string
    The tenant ID of the system-assigned identity of the search service.
    Type string
    The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId String
    The principal ID of the system-assigned identity of the search service.
    tenantId String
    The tenant ID of the system-assigned identity of the search service.
    type String
    The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId string
    The principal ID of the system-assigned identity of the search service.
    tenantId string
    The tenant ID of the system-assigned identity of the search service.
    type string
    The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principal_id str
    The principal ID of the system-assigned identity of the search service.
    tenant_id str
    The tenant ID of the system-assigned identity of the search service.
    type str
    The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId String
    The principal ID of the system-assigned identity of the search service.
    tenantId String
    The tenant ID of the system-assigned identity of the search service.
    type String
    The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.
    userAssignedIdentities Map<Property Map>
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

    IpRuleResponse

    Value string
    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.
    Value string
    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.
    value String
    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.
    value string
    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.
    value str
    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.
    value String
    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.

    NetworkRuleSetResponse

    Bypass string
    Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
    IpRules List<Pulumi.AzureNative.Search.Inputs.IpRuleResponse>
    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.
    Bypass string
    Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
    IpRules []IpRuleResponse
    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.
    bypass String
    Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
    ipRules List<IpRuleResponse>
    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.
    bypass string
    Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
    ipRules IpRuleResponse[]
    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.
    bypass str
    Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
    ip_rules Sequence[IpRuleResponse]
    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.
    bypass String
    Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
    ipRules List<Property Map>
    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.

    PrivateEndpointConnectionPropertiesResponse

    GroupId string
    The group ID of the Azure resource for which the private link service is for.
    PrivateEndpoint Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Azure Private Link service connection to the private endpoint.
    ProvisioningState string
    The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.
    GroupId string
    The group ID of the Azure resource for which the private link service is for.
    PrivateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    PrivateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Azure Private Link service connection to the private endpoint.
    ProvisioningState string
    The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.
    groupId String
    The group ID of the Azure resource for which the private link service is for.
    privateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Azure Private Link service connection to the private endpoint.
    provisioningState String
    The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.
    groupId string
    The group ID of the Azure resource for which the private link service is for.
    privateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Azure Private Link service connection to the private endpoint.
    provisioningState string
    The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.
    group_id str
    The group ID of the Azure resource for which the private link service is for.
    private_endpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    private_link_service_connection_state PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Azure Private Link service connection to the private endpoint.
    provisioning_state str
    The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.
    groupId String
    The group ID of the Azure resource for which the private link service is for.
    privateEndpoint Property Map
    The private endpoint resource from Microsoft.Network provider.
    privateLinkServiceConnectionState Property Map
    Describes the current state of an existing Azure Private Link service connection to the private endpoint.
    provisioningState String
    The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

    PrivateEndpointConnectionPropertiesResponsePrivateEndpoint

    Id string
    The resource ID of the private endpoint resource from Microsoft.Network provider.
    Id string
    The resource ID of the private endpoint resource from Microsoft.Network provider.
    id String
    The resource ID of the private endpoint resource from Microsoft.Network provider.
    id string
    The resource ID of the private endpoint resource from Microsoft.Network provider.
    id str
    The resource ID of the private endpoint resource from Microsoft.Network provider.
    id String
    The resource ID of the private endpoint resource from Microsoft.Network provider.

    PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState

    ActionsRequired string
    A description of any extra actions that may be required.
    Description string
    The description for the private link service connection state.
    Status string
    Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
    ActionsRequired string
    A description of any extra actions that may be required.
    Description string
    The description for the private link service connection state.
    Status string
    Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
    actionsRequired String
    A description of any extra actions that may be required.
    description String
    The description for the private link service connection state.
    status String
    Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
    actionsRequired string
    A description of any extra actions that may be required.
    description string
    The description for the private link service connection state.
    status string
    Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
    actions_required str
    A description of any extra actions that may be required.
    description str
    The description for the private link service connection state.
    status str
    Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
    actionsRequired String
    A description of any extra actions that may be required.
    description String
    The description for the private link service connection state.
    status String
    Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

    PrivateEndpointConnectionResponse

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Search.Inputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Properties Pulumi.AzureNative.Search.Inputs.PrivateEndpointConnectionPropertiesResponse
    Describes the properties of an existing private endpoint connection to the Azure AI Search service.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Properties PrivateEndpointConnectionPropertiesResponse
    Describes the properties of an existing private endpoint connection to the Azure AI Search service.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    properties PrivateEndpointConnectionPropertiesResponse
    Describes the properties of an existing private endpoint connection to the Azure AI Search service.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    properties PrivateEndpointConnectionPropertiesResponse
    Describes the properties of an existing private endpoint connection to the Azure AI Search service.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    properties PrivateEndpointConnectionPropertiesResponse
    Describes the properties of an existing private endpoint connection to the Azure AI Search service.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    properties Property Map
    Describes the properties of an existing private endpoint connection to the Azure AI Search service.

    SharedPrivateLinkResourcePropertiesResponse

    GroupId string
    The group ID from the provider of resource the shared private link resource is for.
    PrivateLinkResourceId string
    The resource ID of the resource the shared private link resource is for.
    ProvisioningState string
    The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
    RequestMessage string
    The message for requesting approval of the shared private link resource.
    ResourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    Status string
    Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
    GroupId string
    The group ID from the provider of resource the shared private link resource is for.
    PrivateLinkResourceId string
    The resource ID of the resource the shared private link resource is for.
    ProvisioningState string
    The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
    RequestMessage string
    The message for requesting approval of the shared private link resource.
    ResourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    Status string
    Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
    groupId String
    The group ID from the provider of resource the shared private link resource is for.
    privateLinkResourceId String
    The resource ID of the resource the shared private link resource is for.
    provisioningState String
    The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage String
    The message for requesting approval of the shared private link resource.
    resourceRegion String
    Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status String
    Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
    groupId string
    The group ID from the provider of resource the shared private link resource is for.
    privateLinkResourceId string
    The resource ID of the resource the shared private link resource is for.
    provisioningState string
    The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage string
    The message for requesting approval of the shared private link resource.
    resourceRegion string
    Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status string
    Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
    group_id str
    The group ID from the provider of resource the shared private link resource is for.
    private_link_resource_id str
    The resource ID of the resource the shared private link resource is for.
    provisioning_state str
    The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
    request_message str
    The message for requesting approval of the shared private link resource.
    resource_region str
    Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status str
    Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
    groupId String
    The group ID from the provider of resource the shared private link resource is for.
    privateLinkResourceId String
    The resource ID of the resource the shared private link resource is for.
    provisioningState String
    The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage String
    The message for requesting approval of the shared private link resource.
    resourceRegion String
    Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status String
    Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

    SharedPrivateLinkResourceResponse

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Search.Inputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Properties Pulumi.AzureNative.Search.Inputs.SharedPrivateLinkResourcePropertiesResponse
    Describes the properties of a shared private link resource managed by the Azure AI Search service.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Properties SharedPrivateLinkResourcePropertiesResponse
    Describes the properties of a shared private link resource managed by the Azure AI Search service.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    properties SharedPrivateLinkResourcePropertiesResponse
    Describes the properties of a shared private link resource managed by the Azure AI Search service.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    properties SharedPrivateLinkResourcePropertiesResponse
    Describes the properties of a shared private link resource managed by the Azure AI Search service.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    properties SharedPrivateLinkResourcePropertiesResponse
    Describes the properties of a shared private link resource managed by the Azure AI Search service.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    properties Property Map
    Describes the properties of a shared private link resource managed by the Azure AI Search service.

    SkuResponse

    Name string
    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.'
    Name string
    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.'
    name String
    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.'
    name string
    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.'
    name str
    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.'
    name String
    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.'

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
    pulumi/pulumi-azure-native