Microsoft.Search searchServices/privateEndpointConnections 2020-03-13
Bicep resource definition
The searchServices/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices/privateEndpointConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Search/searchServices/privateEndpointConnections@2020-03-13' = {
name: 'string'
parent: resourceSymbolicName
properties: {
privateEndpoint: {
id: 'string'
}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
Property values
searchServices/privateEndpointConnections
Name | Description | Value |
---|---|---|
name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: searchServices |
properties | Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Name | Description | Value |
---|---|---|
privateEndpoint | The private endpoint resource from Microsoft.Network provider. | PrivateEndpointConnectionPropertiesPrivateEndpoint |
privateLinkServiceConnectionState | Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. | PrivateEndpointConnectionPropertiesPrivateLinkServic... |
PrivateEndpointConnectionPropertiesPrivateEndpoint
Name | Description | Value |
---|---|---|
id | The resource id of the private endpoint resource from Microsoft.Network provider. | string |
PrivateEndpointConnectionPropertiesPrivateLinkServic...
Name | Description | Value |
---|---|---|
actionsRequired | A description of any extra actions that may be required. | string |
description | The description for the private link service connection state. | string |
status | Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
ARM template resource definition
The searchServices/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices/privateEndpointConnections resource, add the following JSON to your template.
{
"type": "Microsoft.Search/searchServices/privateEndpointConnections",
"apiVersion": "2020-03-13",
"name": "string",
"properties": {
"privateEndpoint": {
"id": "string"
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
Property values
searchServices/privateEndpointConnections
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Search/searchServices/privateEndpointConnections' |
apiVersion | The resource api version | '2020-03-13' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Name | Description | Value |
---|---|---|
privateEndpoint | The private endpoint resource from Microsoft.Network provider. | PrivateEndpointConnectionPropertiesPrivateEndpoint |
privateLinkServiceConnectionState | Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. | PrivateEndpointConnectionPropertiesPrivateLinkServic... |
PrivateEndpointConnectionPropertiesPrivateEndpoint
Name | Description | Value |
---|---|---|
id | The resource id of the private endpoint resource from Microsoft.Network provider. | string |
PrivateEndpointConnectionPropertiesPrivateLinkServic...
Name | Description | Value |
---|---|---|
actionsRequired | A description of any extra actions that may be required. | string |
description | The description for the private link service connection state. | string |
status | Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Terraform (AzAPI provider) resource definition
The searchServices/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Search/searchServices/privateEndpointConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices/privateEndpointConnections@2020-03-13"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
})
}
Property values
searchServices/privateEndpointConnections
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.Search/searchServices/privateEndpointConnections@2020-03-13" |
name | The resource name | string (required) |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: searchServices |
properties | Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Name | Description | Value |
---|---|---|
privateEndpoint | The private endpoint resource from Microsoft.Network provider. | PrivateEndpointConnectionPropertiesPrivateEndpoint |
privateLinkServiceConnectionState | Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. | PrivateEndpointConnectionPropertiesPrivateLinkServic... |
PrivateEndpointConnectionPropertiesPrivateEndpoint
Name | Description | Value |
---|---|---|
id | The resource id of the private endpoint resource from Microsoft.Network provider. | string |
PrivateEndpointConnectionPropertiesPrivateLinkServic...
Name | Description | Value |
---|---|---|
actionsRequired | A description of any extra actions that may be required. | string |
description | The description for the private link service connection state. | string |
status | Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. | "Approved" "Disconnected" "Pending" "Rejected" |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for