Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

LinkedServiceAzureSearch

Manages a Linked Service (connection) between Azure Search Service and Azure Data Factory.

Create LinkedServiceAzureSearch Resource

new LinkedServiceAzureSearch(name: string, args: LinkedServiceAzureSearchArgs, opts?: CustomResourceOptions);
@overload
def LinkedServiceAzureSearch(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             additional_properties: Optional[Mapping[str, str]] = None,
                             annotations: Optional[Sequence[str]] = None,
                             data_factory_id: Optional[str] = None,
                             description: Optional[str] = None,
                             integration_runtime_name: Optional[str] = None,
                             name: Optional[str] = None,
                             parameters: Optional[Mapping[str, str]] = None,
                             search_service_key: Optional[str] = None,
                             url: Optional[str] = None)
@overload
def LinkedServiceAzureSearch(resource_name: str,
                             args: LinkedServiceAzureSearchArgs,
                             opts: Optional[ResourceOptions] = None)
func NewLinkedServiceAzureSearch(ctx *Context, name string, args LinkedServiceAzureSearchArgs, opts ...ResourceOption) (*LinkedServiceAzureSearch, error)
public LinkedServiceAzureSearch(string name, LinkedServiceAzureSearchArgs args, CustomResourceOptions? opts = null)
public LinkedServiceAzureSearch(String name, LinkedServiceAzureSearchArgs args)
public LinkedServiceAzureSearch(String name, LinkedServiceAzureSearchArgs args, CustomResourceOptions options)
type: azure:datafactory:LinkedServiceAzureSearch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args LinkedServiceAzureSearchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args LinkedServiceAzureSearchArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args LinkedServiceAzureSearchArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args LinkedServiceAzureSearchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args LinkedServiceAzureSearchArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

LinkedServiceAzureSearch Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The LinkedServiceAzureSearch resource accepts the following input properties:

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

SearchServiceKey string

The key of the Azure Search Service.

Url string

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

AdditionalProperties Dictionary<string, string>

A map of additional properties to associate with the Data Factory Linked Service.

Annotations List<string>

List of tags that can be used for describing the Data Factory Linked Service.

Description string

The description for the Data Factory Linked Service.

IntegrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service.

Name string

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

Parameters Dictionary<string, string>

A map of parameters to associate with the Data Factory Linked Service.

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

SearchServiceKey string

The key of the Azure Search Service.

Url string

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

AdditionalProperties map[string]string

A map of additional properties to associate with the Data Factory Linked Service.

Annotations []string

List of tags that can be used for describing the Data Factory Linked Service.

Description string

The description for the Data Factory Linked Service.

IntegrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service.

Name string

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

Parameters map[string]string

A map of parameters to associate with the Data Factory Linked Service.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

searchServiceKey String

The key of the Azure Search Service.

url String

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

additionalProperties Map<String,String>

A map of additional properties to associate with the Data Factory Linked Service.

annotations List<String>

List of tags that can be used for describing the Data Factory Linked Service.

description String

The description for the Data Factory Linked Service.

integrationRuntimeName String

The integration runtime reference to associate with the Data Factory Linked Service.

name String

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

parameters Map<String,String>

A map of parameters to associate with the Data Factory Linked Service.

dataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

searchServiceKey string

The key of the Azure Search Service.

url string

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

additionalProperties {[key: string]: string}

A map of additional properties to associate with the Data Factory Linked Service.

annotations string[]

List of tags that can be used for describing the Data Factory Linked Service.

description string

The description for the Data Factory Linked Service.

integrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service.

name string

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

parameters {[key: string]: string}

A map of parameters to associate with the Data Factory Linked Service.

data_factory_id str

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

search_service_key str

The key of the Azure Search Service.

url str

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

additional_properties Mapping[str, str]

A map of additional properties to associate with the Data Factory Linked Service.

annotations Sequence[str]

List of tags that can be used for describing the Data Factory Linked Service.

description str

The description for the Data Factory Linked Service.

integration_runtime_name str

The integration runtime reference to associate with the Data Factory Linked Service.

name str

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

parameters Mapping[str, str]

A map of parameters to associate with the Data Factory Linked Service.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

searchServiceKey String

The key of the Azure Search Service.

url String

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

additionalProperties Map<String>

A map of additional properties to associate with the Data Factory Linked Service.

annotations List<String>

List of tags that can be used for describing the Data Factory Linked Service.

description String

The description for the Data Factory Linked Service.

integrationRuntimeName String

The integration runtime reference to associate with the Data Factory Linked Service.

name String

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

parameters Map<String>

A map of parameters to associate with the Data Factory Linked Service.

Outputs

All input properties are implicitly available as output properties. Additionally, the LinkedServiceAzureSearch resource produces the following output properties:

EncryptedCredential string

The encrypted credential to connect to Azure Search Service.

Id string

The provider-assigned unique ID for this managed resource.

EncryptedCredential string

The encrypted credential to connect to Azure Search Service.

Id string

The provider-assigned unique ID for this managed resource.

encryptedCredential String

The encrypted credential to connect to Azure Search Service.

id String

The provider-assigned unique ID for this managed resource.

encryptedCredential string

The encrypted credential to connect to Azure Search Service.

id string

The provider-assigned unique ID for this managed resource.

encrypted_credential str

The encrypted credential to connect to Azure Search Service.

id str

The provider-assigned unique ID for this managed resource.

encryptedCredential String

The encrypted credential to connect to Azure Search Service.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing LinkedServiceAzureSearch Resource

Get an existing LinkedServiceAzureSearch resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LinkedServiceAzureSearchState, opts?: CustomResourceOptions): LinkedServiceAzureSearch
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        encrypted_credential: Optional[str] = None,
        integration_runtime_name: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        search_service_key: Optional[str] = None,
        url: Optional[str] = None) -> LinkedServiceAzureSearch
func GetLinkedServiceAzureSearch(ctx *Context, name string, id IDInput, state *LinkedServiceAzureSearchState, opts ...ResourceOption) (*LinkedServiceAzureSearch, error)
public static LinkedServiceAzureSearch Get(string name, Input<string> id, LinkedServiceAzureSearchState? state, CustomResourceOptions? opts = null)
public static LinkedServiceAzureSearch get(String name, Output<String> id, LinkedServiceAzureSearchState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdditionalProperties Dictionary<string, string>

A map of additional properties to associate with the Data Factory Linked Service.

Annotations List<string>

List of tags that can be used for describing the Data Factory Linked Service.

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Description string

The description for the Data Factory Linked Service.

EncryptedCredential string

The encrypted credential to connect to Azure Search Service.

IntegrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service.

Name string

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

Parameters Dictionary<string, string>

A map of parameters to associate with the Data Factory Linked Service.

SearchServiceKey string

The key of the Azure Search Service.

Url string

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

AdditionalProperties map[string]string

A map of additional properties to associate with the Data Factory Linked Service.

Annotations []string

List of tags that can be used for describing the Data Factory Linked Service.

DataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Description string

The description for the Data Factory Linked Service.

EncryptedCredential string

The encrypted credential to connect to Azure Search Service.

IntegrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service.

Name string

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

Parameters map[string]string

A map of parameters to associate with the Data Factory Linked Service.

SearchServiceKey string

The key of the Azure Search Service.

Url string

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

additionalProperties Map<String,String>

A map of additional properties to associate with the Data Factory Linked Service.

annotations List<String>

List of tags that can be used for describing the Data Factory Linked Service.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description String

The description for the Data Factory Linked Service.

encryptedCredential String

The encrypted credential to connect to Azure Search Service.

integrationRuntimeName String

The integration runtime reference to associate with the Data Factory Linked Service.

name String

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

parameters Map<String,String>

A map of parameters to associate with the Data Factory Linked Service.

searchServiceKey String

The key of the Azure Search Service.

url String

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

additionalProperties {[key: string]: string}

A map of additional properties to associate with the Data Factory Linked Service.

annotations string[]

List of tags that can be used for describing the Data Factory Linked Service.

dataFactoryId string

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description string

The description for the Data Factory Linked Service.

encryptedCredential string

The encrypted credential to connect to Azure Search Service.

integrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service.

name string

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

parameters {[key: string]: string}

A map of parameters to associate with the Data Factory Linked Service.

searchServiceKey string

The key of the Azure Search Service.

url string

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

additional_properties Mapping[str, str]

A map of additional properties to associate with the Data Factory Linked Service.

annotations Sequence[str]

List of tags that can be used for describing the Data Factory Linked Service.

data_factory_id str

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description str

The description for the Data Factory Linked Service.

encrypted_credential str

The encrypted credential to connect to Azure Search Service.

integration_runtime_name str

The integration runtime reference to associate with the Data Factory Linked Service.

name str

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

parameters Mapping[str, str]

A map of parameters to associate with the Data Factory Linked Service.

search_service_key str

The key of the Azure Search Service.

url str

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

additionalProperties Map<String>

A map of additional properties to associate with the Data Factory Linked Service.

annotations List<String>

List of tags that can be used for describing the Data Factory Linked Service.

dataFactoryId String

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

description String

The description for the Data Factory Linked Service.

encryptedCredential String

The encrypted credential to connect to Azure Search Service.

integrationRuntimeName String

The integration runtime reference to associate with the Data Factory Linked Service.

name String

Specifies the name of the Data Factory Linked Service. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.

parameters Map<String>

A map of parameters to associate with the Data Factory Linked Service.

searchServiceKey String

The key of the Azure Search Service.

url String

The URL of the Search Service endpoint (e.g. https://{searchServiceName}.search.windows.net).

Import

Data Factory Linked Service’s can be imported using the resource id, e.g.

 $ pulumi import azure:datafactory/linkedServiceAzureSearch:LinkedServiceAzureSearch example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.