Microsoft.Search (preview:2025-02-01)

2025/01/16 • 29 new methods

Operations_List (new)
Description Lists all of the available REST API operations of the Microsoft.Search provider.
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.Search/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
operation: string ,
resource: string ,
description: string ,
}
,
isDataAction: boolean ,
origin: string ,
properties:
{
serviceSpecification:
{
metricSpecifications:
[
{
name: string ,
displayName: string ,
displayDescription: string ,
unit: string ,
aggregationType: string ,
dimensions:
[
{
name: string ,
displayName: string ,
}
,
]
,
availabilities:
[
{
timeGrain: string ,
blobDuration: string ,
}
,
]
,
}
,
]
,
logSpecifications:
[
{
name: string ,
displayName: string ,
blobDuration: string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
Offerings_List (new)
Description Lists all of the features and SKUs offered by the Azure AI Search service in each region.
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.Search/offerings
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
regionName: string ,
features:
[
{
name: enum ,
}
,
]
,
skus:
[
{
sku:
{
name: enum ,
}
,
limits:
{
indexes: integer ,
indexers: integer ,
partitionStorageInGigabytes: integer ,
partitionVectorStorageInGigabytes: integer ,
searchUnits: integer ,
replicas: integer ,
partitions: integer ,
}
,
}
,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
AdminKeys_Get (new)
Description Gets the primary and secondary admin API keys for the specified Azure AI Search service.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys
{
resourceGroupName: string ,
searchServiceName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
primaryKey: string ,
secondaryKey: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
AdminKeys_Regenerate (new)
Description Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}
{
resourceGroupName: string ,
searchServiceName: string ,
keyKind: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
primaryKey: string ,
secondaryKey: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
QueryKeys_Create (new)
Description Generates a new query key for the specified search service. You can create up to 50 query keys per service.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}
{
resourceGroupName: string ,
searchServiceName: string ,
name: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
name: string ,
key: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
QueryKeys_ListBySearchService (new)
Description Returns the list of query API keys for the given Azure AI Search service.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys
{
resourceGroupName: string ,
searchServiceName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
key: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
QueryKeys_Delete (new)
Description Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}
{
resourceGroupName: string ,
searchServiceName: string ,
key: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
Services_CreateOrUpdate (new)
Description Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
{
resourceGroupName: string ,
searchServiceName: string ,
service:
{
properties:
{
replicaCount: integer ,
partitionCount: integer ,
endpoint: string ,
hostingMode: enum ,
computeType: enum ,
publicNetworkAccess: enum ,
status: enum ,
statusDetails: string ,
provisioningState: enum ,
networkRuleSet:
{
ipRules:
[
{
value: string ,
}
,
]
,
bypass: enum ,
}
,
disabledDataExfiltrationOptions:
[
string ,
]
,
encryptionWithCmk:
{
enforcement: enum ,
encryptionComplianceStatus: enum ,
}
,
disableLocalAuth: boolean ,
authOptions:
{
apiKeyOnly: object ,
aadOrApiKey:
{
aadAuthFailureMode: enum ,
}
,
}
,
semanticSearch: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
[
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
]
,
eTag: string ,
upgradeAvailable: boolean ,
serviceUpgradeDate: string ,
}
,
sku:
{
name: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
replicaCount: integer ,
partitionCount: integer ,
endpoint: string ,
hostingMode: enum ,
computeType: enum ,
publicNetworkAccess: enum ,
status: enum ,
statusDetails: string ,
provisioningState: enum ,
networkRuleSet:
{
ipRules:
[
{
value: string ,
}
,
]
,
bypass: enum ,
}
,
disabledDataExfiltrationOptions:
[
string ,
]
,
encryptionWithCmk:
{
enforcement: enum ,
encryptionComplianceStatus: enum ,
}
,
disableLocalAuth: boolean ,
authOptions:
{
apiKeyOnly: object ,
aadOrApiKey:
{
aadAuthFailureMode: enum ,
}
,
}
,
semanticSearch: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
[
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
]
,
eTag: string ,
upgradeAvailable: boolean ,
serviceUpgradeDate: string ,
}
,
sku:
{
name: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}

⚐ Response (201)

{
properties:
{
replicaCount: integer ,
partitionCount: integer ,
endpoint: string ,
hostingMode: enum ,
computeType: enum ,
publicNetworkAccess: enum ,
status: enum ,
statusDetails: string ,
provisioningState: enum ,
networkRuleSet:
{
ipRules:
[
{
value: string ,
}
,
]
,
bypass: enum ,
}
,
disabledDataExfiltrationOptions:
[
string ,
]
,
encryptionWithCmk:
{
enforcement: enum ,
encryptionComplianceStatus: enum ,
}
,
disableLocalAuth: boolean ,
authOptions:
{
apiKeyOnly: object ,
aadOrApiKey:
{
aadAuthFailureMode: enum ,
}
,
}
,
semanticSearch: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
[
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
]
,
eTag: string ,
upgradeAvailable: boolean ,
serviceUpgradeDate: string ,
}
,
sku:
{
name: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
Services_Update (new)
Description Updates an existing search service in the given resource group.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
{
resourceGroupName: string ,
searchServiceName: string ,
service:
{
properties:
{
replicaCount: integer ,
partitionCount: integer ,
endpoint: string ,
hostingMode: enum ,
computeType: enum ,
publicNetworkAccess: enum ,
status: enum ,
statusDetails: string ,
provisioningState: enum ,
networkRuleSet:
{
ipRules:
[
{
value: string ,
}
,
]
,
bypass: enum ,
}
,
disabledDataExfiltrationOptions:
[
string ,
]
,
encryptionWithCmk:
{
enforcement: enum ,
encryptionComplianceStatus: enum ,
}
,
disableLocalAuth: boolean ,
authOptions:
{
apiKeyOnly: object ,
aadOrApiKey:
{
aadAuthFailureMode: enum ,
}
,
}
,
semanticSearch: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
[
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
]
,
eTag: string ,
upgradeAvailable: boolean ,
serviceUpgradeDate: string ,
}
,
sku:
{
name: enum ,
}
,
location: string ,
tags: object ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
replicaCount: integer ,
partitionCount: integer ,
endpoint: string ,
hostingMode: enum ,
computeType: enum ,
publicNetworkAccess: enum ,
status: enum ,
statusDetails: string ,
provisioningState: enum ,
networkRuleSet:
{
ipRules:
[
{
value: string ,
}
,
]
,
bypass: enum ,
}
,
disabledDataExfiltrationOptions:
[
string ,
]
,
encryptionWithCmk:
{
enforcement: enum ,
encryptionComplianceStatus: enum ,
}
,
disableLocalAuth: boolean ,
authOptions:
{
apiKeyOnly: object ,
aadOrApiKey:
{
aadAuthFailureMode: enum ,
}
,
}
,
semanticSearch: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
[
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
]
,
eTag: string ,
upgradeAvailable: boolean ,
serviceUpgradeDate: string ,
}
,
sku:
{
name: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
Services_Get (new)
Description Gets the search service with the given name in the given resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
{
resourceGroupName: string ,
searchServiceName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
replicaCount: integer ,
partitionCount: integer ,
endpoint: string ,
hostingMode: enum ,
computeType: enum ,
publicNetworkAccess: enum ,
status: enum ,
statusDetails: string ,
provisioningState: enum ,
networkRuleSet:
{
ipRules:
[
{
value: string ,
}
,
]
,
bypass: enum ,
}
,
disabledDataExfiltrationOptions:
[
string ,
]
,
encryptionWithCmk:
{
enforcement: enum ,
encryptionComplianceStatus: enum ,
}
,
disableLocalAuth: boolean ,
authOptions:
{
apiKeyOnly: object ,
aadOrApiKey:
{
aadAuthFailureMode: enum ,
}
,
}
,
semanticSearch: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
[
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
]
,
eTag: string ,
upgradeAvailable: boolean ,
serviceUpgradeDate: string ,
}
,
sku:
{
name: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
Services_Delete (new)
Description Deletes a search service in the given resource group, along with its associated resources.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
{
resourceGroupName: string ,
searchServiceName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
Services_ListByResourceGroup (new)
Description Gets a list of all Search services in the given resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices
{
resourceGroupName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
replicaCount: integer ,
partitionCount: integer ,
endpoint: string ,
hostingMode: enum ,
computeType: enum ,
publicNetworkAccess: enum ,
status: enum ,
statusDetails: string ,
provisioningState: enum ,
networkRuleSet:
{
ipRules:
[
{
value: string ,
}
,
]
,
bypass: enum ,
}
,
disabledDataExfiltrationOptions:
[
string ,
]
,
encryptionWithCmk:
{
enforcement: enum ,
encryptionComplianceStatus: enum ,
}
,
disableLocalAuth: boolean ,
authOptions:
{
apiKeyOnly: object ,
aadOrApiKey:
{
aadAuthFailureMode: enum ,
}
,
}
,
semanticSearch: enum ,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
]
,
sharedPrivateLinkResources:
[
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
]
,
eTag: string ,
upgradeAvailable: boolean ,
serviceUpgradeDate: string ,
}
,
sku:
{
name: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
PrivateLinkResources_ListSupported (new)
Description Gets a list of all supported private link resource types for the given service.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources
{
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
searchServiceName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
shareablePrivateLinkResourceTypes:
[
{
name: string ,
properties:
{
type: string ,
groupId: string ,
description: string ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
PrivateEndpointConnections_Update (new)
Description Updates a private endpoint connection to the search service in the given resource group.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName: string ,
searchServiceName: string ,
privateEndpointConnectionName: string ,
privateEndpointConnection:
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
PrivateEndpointConnections_Get (new)
Description Gets the details of the private endpoint connection to the search service in the given resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName: string ,
searchServiceName: string ,
privateEndpointConnectionName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
PrivateEndpointConnections_Delete (new)
Description Disconnects the private endpoint connection and deletes it from the search service.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName: string ,
searchServiceName: string ,
privateEndpointConnectionName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
PrivateEndpointConnections_ListByService (new)
Description Gets a list of all private endpoint connections in the given service.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections
{
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
searchServiceName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupId: string ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
SharedPrivateLinkResources_CreateOrUpdate (new)
Description Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
resourceGroupName: string ,
searchServiceName: string ,
sharedPrivateLinkResourceName: string ,
sharedPrivateLinkResource:
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
SharedPrivateLinkResources_Get (new)
Description Gets the details of the shared private link resource managed by the search service in the given resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
resourceGroupName: string ,
searchServiceName: string ,
sharedPrivateLinkResourceName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
SharedPrivateLinkResources_Delete (new)
Description Initiates the deletion of the shared private link resource from the search service.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
resourceGroupName: string ,
searchServiceName: string ,
sharedPrivateLinkResourceName: string ,
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
SharedPrivateLinkResources_ListByService (new)
Description Gets a list of all shared private link resources managed by the given service.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources
{
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
searchServiceName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
privateLinkResourceId: string ,
groupId: string ,
requestMessage: string ,
resourceRegion: string ,
status: enum ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
message: string ,
}
Services_ListBySubscription (new)
Description Gets a list of all Search services in the given subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices
{
x-ms-client-request-id: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
replicaCount: integer ,
partitionCount: integer ,
<