Remove-AzureSearchDocument

NAME Remove-AzureSearchDocument



SYNOPSIS

Removes existing document from the index.





SYNTAX

Remove-AzureSearchDocument [-KeyFieldName] <String> [-KeyFieldValue] <String> [-IndexName] <String> [-JsonRequest]

[-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

The Add-AzureSearchDocument cmdlet lets you removes existing document from the index.





PARAMETERS

-KeyFieldName <String>

The key field name of the index.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-KeyFieldValue <String>

The value of the key field.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IndexName <String>

Azure Search index Name to add documents.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-JsonRequest [<SwitchParameter>]

When specified, result is returned as json object.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Remove-AzureSearchDocument -IndexName hotels -KeyFieldName hotelId -KeyFieldValue 01



This example removes a document with key value of 01 from the hotels index.











RELATED LINKS