SnapshotOperations class
Класс, представляющий SnapshotOperations.
Конструкторы
| Snapshot |
Создайте SnapshotOperations. |
Методы
| apply(string, string, Service |
|
| apply(string, string, Snapshot |
Отправьте операцию для применения моментального снимка к текущей подписке. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take.
|
| apply(string, string, Snapshot |
|
| delete |
Удалите существующий моментальный снимок в соответствии с snapshotId. Все данные объектов и сведения в моментальном снимке также будут удалены. Удалить моментальный снимок может только исходная подписка, которая сделала моментальный снимок. Если пользователь не удаляет моментальный снимок с помощью этого API, моментальный снимок будет по-прежнему автоматически удален через 48 часов после создания. |
| delete |
|
| delete |
|
| get(string, Request |
Получение сведений о моментальном снимке. Моментальный снимок доступен только для исходной подписки, которая его взяла, и целевых подписок, включенных в applyScope в snapshot — Take. |
| get(string, Request |
|
| get(string, Service |
|
| get |
Получение состояния операции создания и применения моментального снимка. |
| get |
|
| get |
|
| list(Service |
|
| list(Snapshot |
Список всех доступных моментальных снимков со связанными сведениями, включая моментальные снимки, сделанные пользователем, или моментальные снимки, которые будут применены к пользователю (идентификатор подписки был включен в applyScope в snapshot — Take). |
| list(Snapshot |
|
| take(Snapshot |
|
| take(Snapshot |
Отправьте операцию для создания моментального снимка списка лиц, большого списка лиц, группы пользователей или большой группы пользователей с указанным пользователем типом моментального снимка, идентификатором исходного объекта, областью применения и необязательными пользовательскими данными.
|
| take(Snapshot |
|
| update(string, Service |
|
| update(string, Snapshot |
Обновление сведений о моментальном снимке. Только исходная подписка, которая сделала моментальный снимок, может обновить моментальный снимок. |
| update(string, Snapshot |
Сведения о конструкторе
SnapshotOperations(FaceClientContext)
Создайте SnapshotOperations.
new SnapshotOperations(client: FaceClientContext)Параметры
- client
- FaceClientContext
Ссылка на клиент службы.
Сведения о методе
apply(string, string, ServiceCallback<void>)
function apply(snapshotId: string, objectId: string, callback: ServiceCallback<void>)Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- objectId
-
string
Пользователь указал идентификатор целевого объекта, который будет создан из моментального снимка.
- callback
-
ServiceCallback<void>
Обратный вызов
apply(string, string, SnapshotApplyOptionalParams)
Отправьте операцию для применения моментального снимка к текущей подписке. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take.
Интерфейсы моментальных снимков предназначены для резервного копирования и восстановления данных о лицах из одной подписки на лица в другую, в том же регионе или между регионами. Рабочий процесс состоит из двух этапов: пользователь сначала вызывает Snapshot - Take, чтобы создать копию исходного объекта и сохранить ее в виде моментального снимка, а затем вызывает Snapshot - Apply, чтобы вставить моментальный снимок в целевую подписку. Моментальные снимки хранятся в централизованном расположении (для каждого экземпляра Azure), поэтому их можно применять между учетными записями и регионами.
Применение моментального снимка является асинхронной операцией. Идентификатор операции можно получить из поля Operation-Location в заголовке ответа, который будет использоваться в OperationStatus — Get для отслеживания хода применения моментального снимка. Идентификатор целевого объекта будет включен в поле "resourceLocation" в OperationStatus — получение ответа, когда операция имеет состояние "успешно".
Время применения моментального снимка зависит от количества записей пользователя и лица в объекте моментального снимка.
Это может быть за секунды или до 1 часа для 1 000 000 человек с несколькими лицами.
Срок действия моментальных снимков автоматически истекает и очищается через 48 часов после создания моментального снимка
- Принять. Таким образом, целевая подписка требуется для применения моментального снимка через 48 часов с момента его создания.
Применение моментального снимка не блокирует другие операции с целевым объектом, однако это не рекомендуется, так как правильность не может быть гарантирована во время применения моментального снимка. После завершения применения моментального снимка все операции с целевым объектом могут работать в обычном режиме. Моментальный снимок также включает результаты обучения исходного объекта. Это означает, что целевая подписка, к которой применен моментальный снимок, не требует повторного обучения целевого объекта перед вызовом Identify/FindSimilar.
Один моментальный снимок можно применить несколько раз параллельно, в то время как в настоящее время поддерживается только СозданиеНовый режим применения, что означает, что операция применения завершится ошибкой, если целевая подписка уже содержит объект того же типа и использует тот же objectId. Пользователи могут указать objectId в тексте запроса, чтобы избежать таких конфликтов.
- Квота подписки бесплатного уровня: 100 операций в месяц.
- Квота на подписку S0 уровней: 100 операций применения в день.
function apply(snapshotId: string, objectId: string, options?: SnapshotApplyOptionalParams): Promise<SnapshotApplyResponse>Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- objectId
-
string
Пользователь указал идентификатор целевого объекта, который будет создан из моментального снимка.
- options
- SnapshotApplyOptionalParams
Необязательные параметры
Возвращаемое значение
Promise<SnapshotApplyResponse>
Promise<Models.SnapshotApplyResponse>
apply(string, string, SnapshotApplyOptionalParams, ServiceCallback<void>)
function apply(snapshotId: string, objectId: string, options: SnapshotApplyOptionalParams, callback: ServiceCallback<void>)Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- objectId
-
string
Пользователь указал идентификатор целевого объекта, который будет создан из моментального снимка.
- options
- SnapshotApplyOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
deleteMethod(string, RequestOptionsBase)
Удалите существующий моментальный снимок в соответствии с snapshotId. Все данные объектов и сведения в моментальном снимке также будут удалены. Удалить моментальный снимок может только исходная подписка, которая сделала моментальный снимок. Если пользователь не удаляет моментальный снимок с помощью этого API, моментальный снимок будет по-прежнему автоматически удален через 48 часов после создания.
function deleteMethod(snapshotId: string, options?: RequestOptionsBase): Promise<RestResponse>Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(snapshotId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- options
- RequestOptionsBase
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(snapshotId: string, callback: ServiceCallback<void>)Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- callback
-
ServiceCallback<void>
Обратный вызов
get(string, RequestOptionsBase)
Получение сведений о моментальном снимке. Моментальный снимок доступен только для исходной подписки, которая его взяла, и целевых подписок, включенных в applyScope в snapshot — Take.
function get(snapshotId: string, options?: RequestOptionsBase): Promise<SnapshotGetResponse>Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<SnapshotGetResponse>
Promise<Models.SnapshotGetResponse>
get(string, RequestOptionsBase, ServiceCallback<Snapshot>)
function get(snapshotId: string, options: RequestOptionsBase, callback: ServiceCallback<Snapshot>)Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
get(string, ServiceCallback<Snapshot>)
function get(snapshotId: string, callback: ServiceCallback<Snapshot>)Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на определенный моментальный снимок.
- callback
Обратный вызов
getOperationStatus(string, RequestOptionsBase)
Получение состояния операции создания и применения моментального снимка.
function getOperationStatus(operationId: string, options?: RequestOptionsBase): Promise<SnapshotGetOperationStatusResponse>Параметры
- operationId
-
string
Идентификатор, ссылающийся на конкретную операцию создания и применения моментального снимка.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<SnapshotGetOperationStatusResponse>
Promise<Models.SnapshotGetOperationStatusResponse>
getOperationStatus(string, RequestOptionsBase, ServiceCallback<OperationStatus>)
function getOperationStatus(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<OperationStatus>)Параметры
- operationId
-
string
Идентификатор, ссылающийся на конкретную операцию создания и применения моментального снимка.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
getOperationStatus(string, ServiceCallback<OperationStatus>)
function getOperationStatus(operationId: string, callback: ServiceCallback<OperationStatus>)Параметры
- operationId
-
string
Идентификатор, ссылающийся на конкретную операцию создания и применения моментального снимка.
- callback
Обратный вызов
list(ServiceCallback<Snapshot[]>)
function list(callback: ServiceCallback<Snapshot[]>)Параметры
- callback
Обратный вызов
list(SnapshotListOptionalParams)
Список всех доступных моментальных снимков со связанными сведениями, включая моментальные снимки, сделанные пользователем, или моментальные снимки, которые будут применены к пользователю (идентификатор подписки был включен в applyScope в snapshot — Take).
function list(options?: SnapshotListOptionalParams): Promise<SnapshotListResponse>Параметры
- options
- SnapshotListOptionalParams
Необязательные параметры
Возвращаемое значение
Promise<SnapshotListResponse>
Promise<Models.SnapshotListResponse>
list(SnapshotListOptionalParams, ServiceCallback<Snapshot[]>)
function list(options: SnapshotListOptionalParams, callback: ServiceCallback<Snapshot[]>)Параметры
- options
- SnapshotListOptionalParams
Необязательные параметры
- callback
Обратный вызов
take(SnapshotObjectType, string, string[], ServiceCallback<void>)
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], callback: ServiceCallback<void>)Параметры
- type
- SnapshotObjectType
Тип, заданный пользователем для исходного объекта, из который будет выполняться создание моментального снимка. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup. Возможные значения: "FaceList", "LargeFaceList", "LargePersonGroup", "PersonGroup".
- objectId
-
string
Пользователь указал идентификатор исходного объекта для создания моментального снимка.
- applyScope
-
string[]
Заданный пользователем массив целевых подписок на распознавание лиц для моментального снимка. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take.
- callback
-
ServiceCallback<void>
Обратный вызов
take(SnapshotObjectType, string, string[], SnapshotTakeOptionalParams)
Отправьте операцию для создания моментального снимка списка лиц, большого списка лиц, группы пользователей или большой группы пользователей с указанным пользователем типом моментального снимка, идентификатором исходного объекта, областью применения и необязательными пользовательскими данными.
Интерфейсы моментальных снимков предназначены для резервного копирования и восстановления данных о лицах из одной подписки на лица в другую, в том же регионе или между регионами. Рабочий процесс состоит из двух этапов: пользователь сначала вызывает Snapshot - Take, чтобы создать копию исходного объекта и сохранить ее в виде моментального снимка, а затем вызывает Snapshot - Apply, чтобы вставить моментальный снимок в целевую подписку. Моментальные снимки хранятся в централизованном расположении (для каждого экземпляра Azure), поэтому их можно применять между учетными записями и регионами.
Создание моментального снимка является асинхронной операцией. Идентификатор операции можно получить из поля Operation-Location в заголовке ответа, который будет использоваться в OperationStatus — Get для отслеживания хода создания моментального снимка. Идентификатор моментального снимка будет включен в поле resourceLocation в OperationStatus — получение ответа, когда операция находится в состоянии "успешно".
Время создания моментального снимка зависит от количества записей пользователей и лиц в исходном объекте. Это может быть за считанные секунды или до нескольких часов для 1 000 000 человек с несколькими лицами.
Срок действия моментальных снимков автоматически истекает и очищается через 48 часов после создания моментального снимка
- Принять. Пользователь может удалить моментальный снимок с помощью функции Моментальный снимок — удалить самостоятельно в любое время до истечения срока действия.
Создание моментального снимка для определенного объекта не блокирует другие операции с объектом. Все операции только для чтения (Get/List и Identify/FindSimilar/Verify) могут выполняться в обычном режиме. Для всех доступных для записи операций, включая добавление, обновление и удаление исходного объекта или его лиц и обучение, они не блокируются, но не рекомендуются, так как доступные для записи обновления могут не отражаться на моментальном снимке во время его создания. После создания моментального снимка все операции, доступные для чтения и записи, могут работать в обычном режиме. Моментальный снимок также будет включать результаты обучения исходного объекта. Это означает, что целевая подписка, к которой применяется моментальный снимок, не требует повторного обучения целевого объекта перед вызовом Identify/FindSimilar.
- Квота подписки бесплатного уровня: 100 операций в месяц.
- Квота на подписку уровня S0: 100 операций в день.
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], options?: SnapshotTakeOptionalParams): Promise<SnapshotTakeResponse>Параметры
- type
- SnapshotObjectType
Тип, заданный пользователем для исходного объекта, из который будет выполняться создание моментального снимка. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup. Возможные значения: FaceList, LargeFaceList, LargePersonGroup, PersonGroup.
- objectId
-
string
Пользователь указал идентификатор исходного объекта для создания моментального снимка.
- applyScope
-
string[]
Указанный пользователем массив целевых идентификаторов подписок распознавания лиц для моментального снимка. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take.
- options
- SnapshotTakeOptionalParams
Необязательные параметры
Возвращаемое значение
Promise<SnapshotTakeResponse>
Promise<Models.SnapshotTakeResponse>
take(SnapshotObjectType, string, string[], SnapshotTakeOptionalParams, ServiceCallback<void>)
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], options: SnapshotTakeOptionalParams, callback: ServiceCallback<void>)Параметры
- type
- SnapshotObjectType
Пользователь указал тип исходного объекта для создания моментального снимка. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup. Возможные значения: FaceList, LargeFaceList, LargePersonGroup, PersonGroup.
- objectId
-
string
Пользователь указал идентификатор исходного объекта для создания моментального снимка.
- applyScope
-
string[]
Указанный пользователем массив целевых идентификаторов подписок распознавания лиц для моментального снимка. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take.
- options
- SnapshotTakeOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов
update(string, ServiceCallback<void>)
function update(snapshotId: string, callback: ServiceCallback<void>)Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на конкретный моментальный снимок.
- callback
-
ServiceCallback<void>
Обратный вызов
update(string, SnapshotUpdateOptionalParams)
Обновление сведений о моментальном снимке. Только исходная подписка, которая сделала моментальный снимок, может обновить моментальный снимок.
function update(snapshotId: string, options?: SnapshotUpdateOptionalParams): Promise<RestResponse>Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на конкретный моментальный снимок.
- options
- SnapshotUpdateOptionalParams
Необязательные параметры
Возвращаемое значение
Promise<RestResponse>
Promise<msRest.RestResponse>
update(string, SnapshotUpdateOptionalParams, ServiceCallback<void>)
function update(snapshotId: string, options: SnapshotUpdateOptionalParams, callback: ServiceCallback<void>)Параметры
- snapshotId
-
string
Идентификатор, ссылающийся на конкретный моментальный снимок.
- options
- SnapshotUpdateOptionalParams
Необязательные параметры
- callback
-
ServiceCallback<void>
Обратный вызов