SnapshotOperations class
Klasse die een SnapshotOperations vertegenwoordigt.
Constructors
| Snapshot |
Maak een SnapshotOperations. |
Methoden
| apply(string, string, Service |
|
| apply(string, string, Snapshot |
Verzend een bewerking om een momentopname toe te passen op het huidige abonnement. Voor elke momentopname kunnen alleen abonnementen die zijn opgenomen in de applyScope of Snapshot - Take deze toepassen.
|
| apply(string, string, Snapshot |
|
| delete |
Een bestaande momentopname verwijderen op basis van de snapshotId. Alle objectgegevens en -informatie in de momentopname worden ook verwijderd. Alleen het bronabonnement dat de momentopname heeft gemaakt, kan de momentopname verwijderen. Als de gebruiker een momentopname met deze API niet verwijdert, wordt de momentopname na het maken nog steeds na het maken automatisch verwijderd. |
| delete |
|
| delete |
|
| get(string, Request |
Informatie over een momentopname ophalen. Momentopname is alleen toegankelijk voor het bronabonnement dat het heeft genomen en doelabonnementen die zijn opgenomen in de applyScope in Snapshot - Take. |
| get(string, Request |
|
| get(string, Service |
|
| get |
Haal de status van een momentopnamebewerking op/pas deze toe. |
| get |
|
| get |
|
| list(Service |
|
| list(Snapshot |
Vermeld alle toegankelijke momentopnamen met gerelateerde informatie, inclusief momentopnamen die door de gebruiker zijn gemaakt of momentopnamen die moeten worden toegepast op de gebruiker (abonnements-id is opgenomen in de applyScope in Snapshot - Take). |
| list(Snapshot |
|
| take(Snapshot |
|
| take(Snapshot |
Verzend een bewerking om een momentopname te maken van een gezichtslijst, een grote gezichtslijst, een persoonsgroep of een grote persoonsgroep, met het door de gebruiker opgegeven momentopnametype, de bronobject-id, het toepassen van het bereik en een optionele gebruikersgegevens.
|
| take(Snapshot |
|
| update(string, Service |
|
| update(string, Snapshot |
Werk de gegevens van een momentopname bij. Alleen het bronabonnement dat de momentopname heeft gemaakt, kan de momentopname bijwerken. |
| update(string, Snapshot |
Constructordetails
SnapshotOperations(FaceClientContext)
Maak een SnapshotOperations.
new SnapshotOperations(client: FaceClientContext)Parameters
- client
- FaceClientContext
Verwijzing naar de serviceclient.
Methodedetails
apply(string, string, ServiceCallback<void>)
function apply(snapshotId: string, objectId: string, callback: ServiceCallback<void>)Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- objectId
-
string
Door de gebruiker opgegeven doelobject-id die moet worden gemaakt op basis van de momentopname.
- callback
-
ServiceCallback<void>
De callback
apply(string, string, SnapshotApplyOptionalParams)
Verzend een bewerking om een momentopname toe te passen op het huidige abonnement. Voor elke momentopname kunnen alleen abonnementen die zijn opgenomen in de applyScope of Snapshot - Take deze toepassen.
De momentopnameinterfaces zijn bedoeld voor gebruikers om een back-up te maken van hun gezichtsgegevens van het ene gezichtsabonnement naar het andere, binnen dezelfde regio of tussen regio's. De werkstroom bevat twee fasen: gebruiker roept momentopname eerst aan: maak een kopie van het bronobject en sla het op als een momentopname en roept vervolgens Momentopname aan. Pas toe om de momentopname te plakken in het doelabonnement. De momentopnamen worden opgeslagen op een centrale locatie (per Azure-exemplaar), zodat ze kunnen worden toegepast op meerdere accounts en regio's.
Het toepassen van momentopnamen is een asynchrone bewerking. Een bewerkings-id kan worden verkregen uit het veld Operation-Location in de antwoordheader, die moet worden gebruikt in OperationStatus - Ophalen voor het bijhouden van de voortgang van het toepassen van de momentopname. De doelobject-id wordt opgenomen in het veld resourceLocation in OperationStatus - Antwoord ophalen wanneer de bewerkingsstatus is geslaagd.
Momentopnamen die tijd toepassen, zijn afhankelijk van het aantal persoons- en gezichtsvermeldingen in het momentopnameobject.
Het kan in seconden of maximaal 1 uur zijn voor 1.000.000 personen met meerdere gezichten.
Momentopnamen worden na 48 uur na het maken van momentopnamen automatisch verlopen en opgeschoond
- Nemen. Het doelabonnement is dus vereist om de momentopname binnen 48 uur toe te passen sinds het maken ervan.
Het toepassen van een momentopname blokkeert geen andere bewerkingen voor het doelobject, maar het wordt niet aanbevolen omdat de juistheid niet kan worden gegarandeerd tijdens het toepassen van momentopnamen. Nadat de momentopname is voltooid, kunnen alle bewerkingen naar het doelobject normaal werken. Momentopname bevat ook de trainingsresultaten van het bronobject. Dit betekent dat het doelabonnement waarop de momentopname is toegepast, het doelobject niet opnieuw hoeft te trainen voordat identificeer/FindSimilar wordt aangeroepen.
Eén momentopname kan meerdere keren parallel worden toegepast, terwijl momenteel alleen de modus CreateNew apply wordt ondersteund. Dit betekent dat de toepassingsbewerking mislukt als het doelabonnement al een object van hetzelfde type bevat en dezelfde object-id gebruikt. Gebruikers kunnen de 'objectId' opgeven in de aanvraagbody om dergelijke conflicten te voorkomen.
- Quotum voor gratis abonnementen: er zijn 100 bewerkingen per maand van toepassing.
- Quotum voor S0-lagen: 100 bewerkingen per dag toepassen.
function apply(snapshotId: string, objectId: string, options?: SnapshotApplyOptionalParams): Promise<SnapshotApplyResponse>Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- objectId
-
string
Door de gebruiker opgegeven doelobject-id die moet worden gemaakt op basis van de momentopname.
- options
- SnapshotApplyOptionalParams
De optionele parameters
Retouren
Promise<SnapshotApplyResponse>
Promise<Models.SnapshotApplyResponse->
apply(string, string, SnapshotApplyOptionalParams, ServiceCallback<void>)
function apply(snapshotId: string, objectId: string, options: SnapshotApplyOptionalParams, callback: ServiceCallback<void>)Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- objectId
-
string
Door de gebruiker opgegeven doelobject-id die moet worden gemaakt op basis van de momentopname.
- options
- SnapshotApplyOptionalParams
De optionele parameters
- callback
-
ServiceCallback<void>
De callback
deleteMethod(string, RequestOptionsBase)
Een bestaande momentopname verwijderen op basis van de snapshotId. Alle objectgegevens en -informatie in de momentopname worden ook verwijderd. Alleen het bronabonnement dat de momentopname heeft gemaakt, kan de momentopname verwijderen. Als de gebruiker een momentopname met deze API niet verwijdert, wordt de momentopname na het maken nog steeds na het maken automatisch verwijderd.
function deleteMethod(snapshotId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- options
- RequestOptionsBase
De optionele parameters
Retouren
Promise<RestResponse>
Beloof<msRest.RestResponse>
deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(snapshotId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- options
- RequestOptionsBase
De optionele parameters
- callback
-
ServiceCallback<void>
De callback
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(snapshotId: string, callback: ServiceCallback<void>)Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- callback
-
ServiceCallback<void>
De callback
get(string, RequestOptionsBase)
Informatie over een momentopname ophalen. Momentopname is alleen toegankelijk voor het bronabonnement dat het heeft genomen en doelabonnementen die zijn opgenomen in de applyScope in Snapshot - Take.
function get(snapshotId: string, options?: RequestOptionsBase): Promise<SnapshotGetResponse>Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- options
- RequestOptionsBase
De optionele parameters
Retouren
Promise<SnapshotGetResponse>
Beloof<modellen.SnapshotGetResponse>
get(string, RequestOptionsBase, ServiceCallback<Snapshot>)
function get(snapshotId: string, options: RequestOptionsBase, callback: ServiceCallback<Snapshot>)Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- options
- RequestOptionsBase
De optionele parameters
- callback
De callback
get(string, ServiceCallback<Snapshot>)
function get(snapshotId: string, callback: ServiceCallback<Snapshot>)Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- callback
De callback
getOperationStatus(string, RequestOptionsBase)
Haal de status van een momentopnamebewerking op/pas deze toe.
function getOperationStatus(operationId: string, options?: RequestOptionsBase): Promise<SnapshotGetOperationStatusResponse>Parameters
- operationId
-
string
Id die verwijst naar een bepaalde bewerking voor het maken/toepassen van momentopnamen.
- options
- RequestOptionsBase
De optionele parameters
Retouren
Promise<SnapshotGetOperationStatusResponse>
Beloof<modellen.SnapshotGetOperationStatusResponse>
getOperationStatus(string, RequestOptionsBase, ServiceCallback<OperationStatus>)
function getOperationStatus(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<OperationStatus>)Parameters
- operationId
-
string
Id die verwijst naar een bepaalde bewerking voor het maken/toepassen van momentopnamen.
- options
- RequestOptionsBase
De optionele parameters
- callback
De callback
getOperationStatus(string, ServiceCallback<OperationStatus>)
function getOperationStatus(operationId: string, callback: ServiceCallback<OperationStatus>)Parameters
- operationId
-
string
Id die verwijst naar een bepaalde bewerking voor het maken/toepassen van momentopnamen.
- callback
De callback
list(ServiceCallback<Snapshot[]>)
function list(callback: ServiceCallback<Snapshot[]>)Parameters
- callback
De callback
list(SnapshotListOptionalParams)
Vermeld alle toegankelijke momentopnamen met gerelateerde informatie, inclusief momentopnamen die door de gebruiker zijn gemaakt of momentopnamen die moeten worden toegepast op de gebruiker (abonnements-id is opgenomen in de applyScope in Snapshot - Take).
function list(options?: SnapshotListOptionalParams): Promise<SnapshotListResponse>Parameters
- options
- SnapshotListOptionalParams
De optionele parameters
Retouren
Promise<SnapshotListResponse>
Beloof<modellen.SnapshotListResponse>
list(SnapshotListOptionalParams, ServiceCallback<Snapshot[]>)
function list(options: SnapshotListOptionalParams, callback: ServiceCallback<Snapshot[]>)Parameters
- options
- SnapshotListOptionalParams
De optionele parameters
- callback
De callback
take(SnapshotObjectType, string, string[], ServiceCallback<void>)
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], callback: ServiceCallback<void>)Parameters
- type
- SnapshotObjectType
Door de gebruiker opgegeven type voor het bronobject waaruit een momentopname moet worden gemaakt. Momenteel worden FaceList, PersonGroup, LargeFaceList en LargePersonGroup ondersteund. Mogelijke waarden zijn: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
- objectId
-
string
Door de gebruiker opgegeven bronobject-id waaruit een momentopname moet worden gemaakt.
- applyScope
-
string[]
Door de gebruiker opgegeven matrix met doel-Face-abonnements-id's voor de momentopname. Voor elke momentopname kunnen alleen abonnementen die zijn opgenomen in de applyScope of Snapshot - Take deze toepassen.
- callback
-
ServiceCallback<void>
De callback
take(SnapshotObjectType, string, string[], SnapshotTakeOptionalParams)
Verzend een bewerking om een momentopname te maken van een gezichtslijst, een grote gezichtslijst, een persoonsgroep of een grote persoonsgroep, met het door de gebruiker opgegeven momentopnametype, de bronobject-id, het toepassen van het bereik en een optionele gebruikersgegevens.
De momentopnameinterfaces zijn bedoeld voor gebruikers om een back-up te maken van hun gezichtsgegevens van het ene gezichtsabonnement naar het andere, binnen dezelfde regio of tussen regio's. De werkstroom bevat twee fasen: gebruiker roept momentopname eerst aan: maak een kopie van het bronobject en sla het op als een momentopname en roept vervolgens Momentopname aan. Pas toe om de momentopname te plakken in het doelabonnement. De momentopnamen worden opgeslagen op een centrale locatie (per Azure-exemplaar), zodat ze kunnen worden toegepast op meerdere accounts en regio's.
Momentopname maken is een asynchrone bewerking. Een bewerkings-id kan worden verkregen uit het veld Operation-Location in de antwoordheader, die moet worden gebruikt in OperationStatus - Ophalen voor het bijhouden van de voortgang van het maken van de momentopname. De momentopname-id wordt opgenomen in het veld resourceLocation in OperationStatus - Antwoord ophalen wanneer de bewerkingsstatus is geslaagd.
Momentopnamen die tijd nemen, zijn afhankelijk van het aantal persoons- en gezichtsvermeldingen in het bronobject. Het kan in seconden of maximaal enkele uren duren voor 1.000.000 personen met meerdere gezichten.
Momentopnamen worden na 48 uur na het maken van momentopnamen automatisch verlopen en opgeschoond
- Nemen. De gebruiker kan de momentopname verwijderen met behulp van Momentopname - Verwijderen op elk gewenst moment voordat deze verloopt.
Als u een momentopname voor een bepaald object maakt, worden er geen andere bewerkingen voor het object geblokkeerd. Alle alleen-lezen bewerkingen (Get/List and Identify/FindSimilar/Verify) kunnen zoals gebruikelijk worden uitgevoerd. Voor alle schrijfbare bewerkingen, waaronder het toevoegen/bijwerken/verwijderen van het bronobject of de bijbehorende personen/gezichten en Trainen, worden ze niet geblokkeerd, maar niet aanbevolen omdat schrijfbare updates mogelijk niet worden weergegeven op de momentopname tijdens het maken ervan. Nadat het maken van momentopnamen is voltooid, kunnen alle leesbare en beschrijfbare bewerkingen als normaal werken. Momentopname bevat ook de trainingsresultaten van het bronobject. Dit betekent dat het doelabonnement waarop de momentopname is toegepast, het doelobject niet opnieuw hoeft te trainen voordat Identificeer/FindSimilar wordt aangeroepen.
- Quotum voor gratis abonnementen: 100 take operations per maand.
- Quotum voor S0-lagen: 100 bewerkingen per dag.
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], options?: SnapshotTakeOptionalParams): Promise<SnapshotTakeResponse>Parameters
- type
- SnapshotObjectType
Door de gebruiker opgegeven type voor het bronobject waaruit een momentopname moet worden gemaakt. Momenteel worden FaceList, PersonGroup, LargeFaceList en LargePersonGroup ondersteund. Mogelijke waarden zijn: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
- objectId
-
string
Door de gebruiker opgegeven bronobject-id waaruit een momentopname moet worden gemaakt.
- applyScope
-
string[]
Door de gebruiker opgegeven matrix met doel-Face-abonnements-id's voor de momentopname. Voor elke momentopname kunnen alleen abonnementen die zijn opgenomen in de applyScope of Snapshot - Take deze toepassen.
- options
- SnapshotTakeOptionalParams
De optionele parameters
Retouren
Promise<SnapshotTakeResponse>
Beloof<modellen.SnapshotTakeResponse>
take(SnapshotObjectType, string, string[], SnapshotTakeOptionalParams, ServiceCallback<void>)
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], options: SnapshotTakeOptionalParams, callback: ServiceCallback<void>)Parameters
- type
- SnapshotObjectType
Door de gebruiker opgegeven type voor het bronobject waaruit een momentopname moet worden gemaakt. Momenteel worden FaceList, PersonGroup, LargeFaceList en LargePersonGroup ondersteund. Mogelijke waarden zijn: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
- objectId
-
string
Door de gebruiker opgegeven bronobject-id waaruit een momentopname moet worden gemaakt.
- applyScope
-
string[]
Door de gebruiker opgegeven matrix met doel-Face-abonnements-id's voor de momentopname. Voor elke momentopname kunnen alleen abonnementen die zijn opgenomen in de applyScope of Snapshot - Take deze toepassen.
- options
- SnapshotTakeOptionalParams
De optionele parameters
- callback
-
ServiceCallback<void>
De callback
update(string, ServiceCallback<void>)
function update(snapshotId: string, callback: ServiceCallback<void>)Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- callback
-
ServiceCallback<void>
De callback
update(string, SnapshotUpdateOptionalParams)
Werk de gegevens van een momentopname bij. Alleen het bronabonnement dat de momentopname heeft gemaakt, kan de momentopname bijwerken.
function update(snapshotId: string, options?: SnapshotUpdateOptionalParams): Promise<RestResponse>Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- options
- SnapshotUpdateOptionalParams
De optionele parameters
Retouren
Promise<RestResponse>
Beloof<msRest.RestResponse>
update(string, SnapshotUpdateOptionalParams, ServiceCallback<void>)
function update(snapshotId: string, options: SnapshotUpdateOptionalParams, callback: ServiceCallback<void>)Parameters
- snapshotId
-
string
Id die verwijst naar een bepaalde momentopname.
- options
- SnapshotUpdateOptionalParams
De optionele parameters
- callback
-
ServiceCallback<void>
De callback