Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-search

Package version

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AdminKeyKind

AdminKeyKind: "primary" | "secondary"

Defines values for AdminKeyKind. Possible values include: 'primary', 'secondary'

readonly
enum

{string}

AdminKeysGetResponse

AdminKeysGetResponse: AdminKeyResult & object

Contains response data for the get operation.

AdminKeysRegenerateResponse

AdminKeysRegenerateResponse: AdminKeyResult & object

Contains response data for the regenerate operation.

HostingMode

HostingMode: "default" | "highDensity"

Defines values for HostingMode. Possible values include: 'default', 'highDensity'

readonly
enum

{string}

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

ProvisioningState

ProvisioningState: "succeeded" | "provisioning" | "failed"

Defines values for ProvisioningState. Possible values include: 'succeeded', 'provisioning', 'failed'

readonly
enum

{string}

QueryKeysCreateResponse

QueryKeysCreateResponse: QueryKey & object

Contains response data for the create operation.

QueryKeysListBySearchServiceResponse

QueryKeysListBySearchServiceResponse: ListQueryKeysResult & object

Contains response data for the listBySearchService operation.

SearchServiceStatus

SearchServiceStatus: "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error"

Defines values for SearchServiceStatus. Possible values include: 'running', 'provisioning', 'deleting', 'degraded', 'disabled', 'error'

readonly
enum

{string}

ServicesBeginCreateOrUpdateResponse

ServicesBeginCreateOrUpdateResponse: SearchService & object

Contains response data for the beginCreateOrUpdate operation.

ServicesCheckNameAvailabilityResponse

ServicesCheckNameAvailabilityResponse: CheckNameAvailabilityOutput & object

Contains response data for the checkNameAvailability operation.

ServicesCreateOrUpdateResponse

ServicesCreateOrUpdateResponse: SearchService & object

Contains response data for the createOrUpdate operation.

ServicesGetResponse

ServicesGetResponse: SearchService & object

Contains response data for the get operation.

ServicesListByResourceGroupResponse

ServicesListByResourceGroupResponse: SearchServiceListResult & object

Contains response data for the listByResourceGroup operation.

ServicesUpdateResponse

ServicesUpdateResponse: SearchService & object

Contains response data for the update operation.

SkuName

SkuName: "free" | "basic" | "standard" | "standard2" | "standard3"

Defines values for SkuName. Possible values include: 'free', 'basic', 'standard', 'standard2', 'standard3'

readonly
enum

{string}

UnavailableNameReason

UnavailableNameReason: "Invalid" | "AlreadyExists"

Defines values for UnavailableNameReason. Possible values include: 'Invalid', 'AlreadyExists'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: any = BaseResourceMapper

Const CloudError

CloudError: any = CloudErrorMapper

Object literals

Const AdminKeyResult

AdminKeyResult: object

serializedName

serializedName: string = "AdminKeyResult"

type

type: object

className

className: string = "AdminKeyResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

primaryKey

primaryKey: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "primaryKey"

type

type: object

name

name: string = "String"

secondaryKey

secondaryKey: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "secondaryKey"

type

type: object

name

name: string = "String"

Const CheckNameAvailabilityInput

CheckNameAvailabilityInput: object

serializedName

serializedName: string = "CheckNameAvailabilityInput"

type

type: object

className

className: string = "CheckNameAvailabilityInput"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

type

type: object

defaultValue

defaultValue: string = "searchServices"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const CheckNameAvailabilityOutput

CheckNameAvailabilityOutput: object

serializedName

serializedName: string = "CheckNameAvailabilityOutput"

type

type: object

className

className: string = "CheckNameAvailabilityOutput"

name

name: string = "Composite"

modelProperties

modelProperties: object

isNameAvailable

isNameAvailable: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nameAvailable"

type

type: object

name

name: string = "Boolean"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

reason

reason: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "reason"

type

type: object

name

name: string = "String"

Const Identity

Identity: object

serializedName

serializedName: string = "Identity"

type

type: object

className

className: string = "Identity"

name

name: string = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: string = "String"

tenantId

tenantId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: string = "String"

type

type: object

defaultValue

defaultValue: string = "SystemAssigned"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const ListQueryKeysResult

ListQueryKeysResult: object

serializedName

serializedName: string = "ListQueryKeysResult"

type

type: object

className

className: string = "ListQueryKeysResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = ""

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "QueryKey"

name

name: string = "Composite"

Const Operation

Operation: object

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

modelProperties

modelProperties: object

display

display: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const OperationDisplay

OperationDisplay: object

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

operation

operation: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: string = "String"

provider

provider: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

resource

resource: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "resource"

type

type: object

name

name: string = "String"

Const OperationListResult

OperationListResult: object

serializedName

serializedName: string = "OperationListResult"

type

type: object

className

className: string = "OperationListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = ""

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

Const QueryKey

QueryKey: object

serializedName

serializedName: string = "QueryKey"

type

type: object

className

className: string = "QueryKey"

name

name: string = "Composite"

modelProperties

modelProperties: object

key

key: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const Resource

Resource: object

serializedName

serializedName: string = "Resource"

type

type: object

className

className: string = "Resource"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "Identity"

name

name: string = "Composite"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const SearchManagementRequestOptions

SearchManagementRequestOptions: object

type

type: object

className

className: string = "SearchManagementRequestOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: string = "Uuid"

Const SearchService

SearchService: object

serializedName

serializedName: string = "SearchService"

type

type: object

className

className: string = "SearchService"

name

name: string = "Composite"

modelProperties

modelProperties: object

hostingMode

hostingMode: object

defaultValue

defaultValue: string = "default"

serializedName

serializedName: string = "properties.hostingMode"

type

type: object

allowedValues

allowedValues: string[] = ["default","highDensity"]

name

name: string = "Enum"

partitionCount

partitionCount: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "properties.partitionCount"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 12

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

provisioningState

provisioningState: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["succeeded","provisioning","failed"]

name

name: string = "Enum"

replicaCount

replicaCount: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "properties.replicaCount"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 12

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "Sku"

name

name: string = "Composite"

status

status: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["running","provisioning","deleting","degraded","disabled","error"]

name

name: string = "Enum"

statusDetails

statusDetails: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.statusDetails"

type

type: object

name

name: string = "String"

Const SearchServiceListResult

SearchServiceListResult: object

serializedName

serializedName: string = "SearchServiceListResult"

type

type: object

className

className: string = "SearchServiceListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = ""

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SearchService"

name

name: string = "Composite"

Const Sku

Sku: object

serializedName

serializedName: string = "Sku"

type

type: object

className

className: string = "Sku"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

allowedValues

allowedValues: string[] = ["free","basic","standard","standard2","standard3"]

name

name: string = "Enum"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const clientRequestId

clientRequestId: object

parameterPath

parameterPath: string[] = ["options","searchManagementRequestOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: string = "Uuid"

Const key

key: object

parameterPath

parameterPath: string = "key"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

Const keyKind

keyKind: object

parameterPath

parameterPath: string = "keyKind"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "keyKind"

type

type: object

allowedValues

allowedValues: string[] = ["primary","secondary"]

name

name: string = "Enum"

Const name

name: object

parameterPath

parameterPath: string = "name"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: string = "String"

Const searchServiceName

searchServiceName: object

parameterPath

parameterPath: string = "searchServiceName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "searchServiceName"

type

type: object

name

name: string = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: string = "String"

Generated using TypeDoc