Guides

MICROSOFT.SEARCH

Suggest Edits
docs.microsoft.com
Azure documentation

AdminKeys_Get

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

AdminKeys_List

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.serviceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

AdminKeys_Regenerate

enum_KeyKindParameter := [ "primary", "secondary" ]

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.keyKind == enum_KeyKindParameter[_]
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

NetworkSecurityPerimeterConfigurations_Get

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.nspConfigName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

NetworkSecurityPerimeterConfigurations_ListByService

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

NetworkSecurityPerimeterConfigurations_Reconcile

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.nspConfigName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Operations_List

valid {
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
}

PrivateEndpointConnections_Delete

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.privateEndpointConnectionName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

PrivateEndpointConnections_Get

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.privateEndpointConnectionName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

PrivateEndpointConnections_ListByService

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

PrivateEndpointConnections_Update

enum_PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateStatus := [ "Pending", "Approved", "Rejected", "Disconnected" ]
enum_PrivateEndpointConnectionPropertiesProvisioningState := [ "Updating", "Deleting", "Failed", "Succeeded", "Incomplete", "Canceled" ]

valid {
    input.Body.properties.privateEndpoint.id == STRING
    input.Body.properties.privateLinkServiceConnectionState.status == enum_PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateStatus[_]
    input.Body.properties.privateLinkServiceConnectionState.description == STRING
    input.Body.properties.privateLinkServiceConnectionState.actionsRequired == STRING
    input.Body.properties.groupId == STRING
    input.Body.properties.provisioningState == enum_PrivateEndpointConnectionPropertiesProvisioningState[_]
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.privateEndpointConnectionName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

PrivateLinkResources_ListSupported

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

QueryKeys_Create

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.name == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

QueryKeys_Delete

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.key == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

QueryKeys_List

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.serviceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

QueryKeys_ListBySearchService

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

QueryKeys_ListBySearchServiceGet

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Services_CheckNameAvailability

enum_CheckNameAvailabilityInputType := [ "searchServices" ]

valid {
    input.Body.name == STRING
    input.Body.type == enum_CheckNameAvailabilityInputType[_]
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
}

Services_CreateOrUpdate

enum_DataPlaneAadOrApiKeyAuthOptionAadAuthFailureMode := [ "http403", "http401WithBearerChallenge" ]
enum_DisabledDataExfiltrationOption := [ "All" ]
enum_EncryptionWithCmkEnforcement := [ "Disabled", "Enabled", "Unspecified" ]
enum_IdentityType := [ "None", "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned" ]
enum_NetworkRuleSetBypass := [ "None", "AzurePortal" ]
enum_SearchServicePropertiesHostingMode := [ "default", "highDensity" ]
enum_SearchServicePropertiesPublicNetworkAccess := [ "enabled", "disabled" ]
enum_SemanticSearch := [ "disabled", "free", "standard" ]
enum_SkuName := [ "free", "basic", "standard", "standard2", "standard3", "storage_optimized_l1", "storage_optimized_l2" ]

valid {
    input.Body.properties.replicaCount == INTEGER
    input.Body.properties.partitionCount == INTEGER
    input.Body.properties.hostingMode == enum_SearchServicePropertiesHostingMode[_]
    input.Body.properties.publicNetworkAccess == enum_SearchServicePropertiesPublicNetworkAccess[_]
    input.Body.properties.networkRuleSet.ipRules[_].value == STRING
    input.Body.properties.networkRuleSet.bypass == enum_NetworkRuleSetBypass[_]
    input.Body.properties.disabledDataExfiltrationOptions[_] == enum_DisabledDataExfiltrationOption[_]
    input.Body.properties.encryptionWithCmk.enforcement == enum_EncryptionWithCmkEnforcement[_]
    input.Body.properties.disableLocalAuth == BOOLEAN
    input.Body.properties.authOptions.apiKeyOnly.STRING == STRING
    input.Body.properties.authOptions.aadOrApiKey.aadAuthFailureMode == enum_DataPlaneAadOrApiKeyAuthOptionAadAuthFailureMode[_]
    input.Body.properties.semanticSearch == enum_SemanticSearch[_]
    input.Body.sku.name == enum_SkuName[_]
    input.Body.identity.type == enum_IdentityType[_]
    input.Body.identity.userAssignedIdentities.STRING == {}
    input.Body.tags.STRING == STRING
    input.Body.location == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Services_Delete

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Services_Get

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Services_ListByResourceGroup

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Services_ListBySubscription

valid {
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
}

Services_Update

enum_DataPlaneAadOrApiKeyAuthOptionAadAuthFailureMode := [ "http403", "http401WithBearerChallenge" ]
enum_DisabledDataExfiltrationOption := [ "All" ]
enum_EncryptionWithCmkEnforcement := [ "Disabled", "Enabled", "Unspecified" ]
enum_IdentityType := [ "None", "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned" ]
enum_NetworkRuleSetBypass := [ "None", "AzurePortal" ]
enum_SearchServicePropertiesHostingMode := [ "default", "highDensity" ]
enum_SearchServicePropertiesPublicNetworkAccess := [ "enabled", "disabled" ]
enum_SemanticSearch := [ "disabled", "free", "standard" ]
enum_SkuName := [ "free", "basic", "standard", "standard2", "standard3", "storage_optimized_l1", "storage_optimized_l2" ]

valid {
    input.Body.properties.replicaCount == INTEGER
    input.Body.properties.partitionCount == INTEGER
    input.Body.properties.hostingMode == enum_SearchServicePropertiesHostingMode[_]
    input.Body.properties.publicNetworkAccess == enum_SearchServicePropertiesPublicNetworkAccess[_]
    input.Body.properties.networkRuleSet.ipRules[_].value == STRING
    input.Body.properties.networkRuleSet.bypass == enum_NetworkRuleSetBypass[_]
    input.Body.properties.disabledDataExfiltrationOptions[_] == enum_DisabledDataExfiltrationOption[_]
    input.Body.properties.encryptionWithCmk.enforcement == enum_EncryptionWithCmkEnforcement[_]
    input.Body.properties.disableLocalAuth == BOOLEAN
    input.Body.properties.authOptions.apiKeyOnly.STRING == STRING
    input.Body.properties.authOptions.aadOrApiKey.aadAuthFailureMode == enum_DataPlaneAadOrApiKeyAuthOptionAadAuthFailureMode[_]
    input.Body.properties.semanticSearch == enum_SemanticSearch[_]
    input.Body.sku.name == enum_SkuName[_]
    input.Body.location == STRING
    input.Body.tags.STRING == STRING
    input.Body.identity.type == enum_IdentityType[_]
    input.Body.identity.userAssignedIdentities.STRING == {}
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

SharedPrivateLinkResources_CreateOrUpdate

enum_SharedPrivateLinkResourcePropertiesProvisioningState := [ "Updating", "Deleting", "Failed", "Succeeded", "Incomplete" ]
enum_SharedPrivateLinkResourcePropertiesStatus := [ "Pending", "Approved", "Rejected", "Disconnected" ]

valid {
    input.Body.properties.privateLinkResourceId == STRING
    input.Body.properties.groupId == STRING
    input.Body.properties.requestMessage == STRING
    input.Body.properties.resourceRegion == STRING
    input.Body.properties.status == enum_SharedPrivateLinkResourcePropertiesStatus[_]
    input.Body.properties.provisioningState == enum_SharedPrivateLinkResourcePropertiesProvisioningState[_]
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.sharedPrivateLinkResourceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

SharedPrivateLinkResources_Delete

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.sharedPrivateLinkResourceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

SharedPrivateLinkResources_Get

valid {
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.ReqMap.sharedPrivateLinkResourceName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

SharedPrivateLinkResources_ListByService

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.searchServiceName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

UsageBySubscriptionSku

valid {
    input.ReqMap.location == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.skuName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
}

Usages_ListBySubscription

valid {
    input.ReqMap.location == STRING
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
}

Updated 8 months ago