Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. search
  5. getService
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.search.getService

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Gets the search service with the given name in the given resource group. API Version: 2020-08-01.

    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 Cognitive 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 Cognitive 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 Cognitive 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 Cognitive 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 Cognitive 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 Cognitive Search service associated with the specified resource group.

    getService Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /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 Cognitive 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.
    SharedPrivateLinkResources List<Pulumi.AzureNative.Search.Outputs.SharedPrivateLinkResourceResponse>
    The list of shared private link resources managed by the Azure Cognitive 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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
    StatusDetails string
    The details of the search service status.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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 Cognitive 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.
    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.
    Id string
    Fully qualified resource ID for the resource. Ex - /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 Cognitive 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.
    SharedPrivateLinkResources []SharedPrivateLinkResourceResponse
    The list of shared private link resources managed by the Azure Cognitive 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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
    StatusDetails string
    The details of the search service status.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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 Cognitive 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.
    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.
    id String
    Fully qualified resource ID for the resource. Ex - /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 Cognitive 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.
    sharedPrivateLinkResources List<SharedPrivateLinkResourceResponse>
    The list of shared private link resources managed by the Azure Cognitive 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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
    statusDetails String
    The details of the search service status.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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 Cognitive 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.
    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.
    id string
    Fully qualified resource ID for the resource. Ex - /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 Cognitive 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.
    sharedPrivateLinkResources SharedPrivateLinkResourceResponse[]
    The list of shared private link resources managed by the Azure Cognitive 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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
    statusDetails string
    The details of the search service status.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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 Cognitive 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.
    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.
    id str
    Fully qualified resource ID for the resource. Ex - /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 Cognitive 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.
    shared_private_link_resources Sequence[SharedPrivateLinkResourceResponse]
    The list of shared private link resources managed by the Azure Cognitive 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. 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.
    status_details str
    The details of the search service status.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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 Cognitive 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.
    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.
    id String
    Fully qualified resource ID for the resource. Ex - /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 Cognitive 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.
    sharedPrivateLinkResources List<Property Map>
    The list of shared private link resources managed by the Azure Cognitive 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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
    statusDetails String
    The details of the search service status.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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 Cognitive 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.
    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.

    Supporting Types

    IdentityResponse

    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.
    principalId string
    The principal ID of resource identity.
    tenantId string
    The tenant ID of resource.
    type string
    The identity type.
    principal_id str
    The principal ID of resource identity.
    tenant_id str
    The tenant ID of resource.
    type str
    The identity type.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.

    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

    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.
    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.
    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.
    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.
    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.
    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

    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 Private Link Service connection to the Azure Private Endpoint.
    PrivateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    PrivateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
    privateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
    privateEndpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    privateLinkServiceConnectionState PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
    private_endpoint PrivateEndpointConnectionPropertiesResponsePrivateEndpoint
    The private endpoint resource from Microsoft.Network provider.
    private_link_service_connection_state PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState
    Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
    privateEndpoint Property Map
    The private endpoint resource from Microsoft.Network provider.
    privateLinkServiceConnectionState Property Map
    Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

    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. Can be 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. Can be 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. Can be 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. Can be 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. Can be 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. Can be Pending, Approved, Rejected, or Disconnected.

    PrivateEndpointConnectionResponse

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    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 Cognitive Search service.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    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 Cognitive Search service.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    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 Cognitive Search service.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    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 Cognitive Search service.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    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 Cognitive Search service.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    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 Cognitive 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. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    RequestMessage string
    The request 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 to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    Status string
    Status of the shared private link resource. Can be 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. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    RequestMessage string
    The request 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 to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    Status string
    Status of the shared private link resource. Can be 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. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage String
    The request 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 to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status String
    Status of the shared private link resource. Can be 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. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage string
    The request 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 to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status string
    Status of the shared private link resource. Can be 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. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    request_message str
    The request 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 to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status str
    Status of the shared private link resource. Can be 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. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
    requestMessage String
    The request 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 to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
    status String
    Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.

    SharedPrivateLinkResourceResponse

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    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 Cognitive Search service.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    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 Cognitive Search service.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    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 Cognitive Search service.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    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 Cognitive Search service.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    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 Cognitive Search service.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    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 Cognitive 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.'

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native