Системные функции работы с журналами Azure Monitor
Azure Backup предоставляет набор функций, называемых системными функциями или функциями решения, которые по умолчанию доступны в рабочих областях Log Analytics (LA).
Эти функции работают с данными из таблиц необработанных данных Azure Backup в LA. Они возвращают форматированные данные, из которых можно легко получить сведения обо всех сущностях, связанных с резервным копированием ваших данных, применяя простые запросы. Пользователи могут передавать в эти функции параметры для фильтрации данных, возвращаемых функциями.
Рекомендуется использовать системные функции для запроса данных резервного копирования в рабочих областях LA для создания пользовательских отчетов, так как они предоставляют ряд преимуществ, описанных ниже.
Преимущества использования системных функций
Более простые запросы. Использование функций помогает сократить количество соединений, необходимых в запросах. По умолчанию функции возвращают "плоские" схемы, включающие все сведения, относящиеся к запрашиваемой сущности (экземпляр резервной копии, задание, хранилище и т. д.). Например, если необходимо получить список успешных заданий резервного копирования по имени элемента резервного копирования и связанному с ним контейнеру, простой вызов функции _AzureBackup_getJobs() предоставит все эти сведения для каждого задания. С другой стороны, прямой запрос таблиц необработанных данных потребует выполнения нескольких операций соединения между таблицами AddonAzureBackupJobs и CoreAzureBackup.
Более плавный переход от устаревшего диагностического события. Использование системных функций позволяет плавно перейти от устаревшего диагностического события (AzureBackupReport в режиме AzureDiagnostics) к событиям для конкретного ресурса. Все системные функции, предоставляемые Azure Backup, позволяют указать параметр, позволяющий выбрать, следует ли запрашивать данные только из таблиц, относящихся к ресурсам, или запрашивать данные как из таблицы прежних версий, так и из таблиц, относящихся к ресурсам (с дедупликацией записей).
- Если вы успешно выполнили миграцию к таблицам для конкретных ресурсов, можно исключить устаревшую таблицу из списка таблиц, данные которых запрашивает функция.
- Если в настоящее время выполняется миграция и устаревшие таблицы содержат некоторые данные, необходимые для анализа, устаревшую таблицу можно включить. Если переход завершен и данные из устаревшей таблицы больше не нужны, можно просто обновить значение параметра, передаваемое функции в запросах, чтобы исключить устаревшую таблицу.
- Если вы по-прежнему используете только устаревшую таблицу и решили включить ее с помощью того же самого параметра, функции будут работать. Тем не менее рекомендуется при первой возможности перейти к использованию таблиц для конкретных ресурсов.
Уменьшается вероятность прерывания пользовательских запросов. Если Azure Backup вводит улучшения в схему базовых таблиц LA с целью поддержки будущих сценариев создания отчетов, определение функций также обновляется с учетом изменений схемы. Таким образом, при создании с помощью системных функций пользовательские запросы не будут прерываться, даже при наличии изменений в базовой схеме таблиц.
Примечание
Поддержку системных функций осуществляет корпорация Майкрософт. Менять их определения пользователи не могут. Если вам необходимы редактируемые функции, в LA можно создавать сохраненные функции.
Типы системных функций, предлагаемых Azure Backup
Основные функции. Это функции, которые помогают запрашивать любые ключевые сущности Azure Backup, например экземпляры резервной копии, хранилища, политики, задания и сущности выставления счетов. Например, функция _AzureBackup_getBackupInstances возвращает список всех экземпляров резервной копии, существующих в среде, по состоянию на последний прошедший день (в формате UTC). Общие сведения о параметрах и возвращаемой схеме для каждой из этих основных функций приведены далее в этой статье.
Функции тренда. Это функции, которые возвращают исторические записи для сущностей, относящихся к резервной копии (например, экземпляры резервной копии, группы выставления счетов), и позволяют получать информацию о ежедневных, еженедельных и ежемесячных тенденциях ключевых метрик (например, объема потребляемой памяти), относящихся к этим сущностям. Общие сведения о параметрах и возвращаемой схеме для каждой из этих функций тренда приведены далее в этой статье.
Примечание
В настоящее время системные функции возвращают данные по состоянию на последний прошедший день (в формате UTC). Данные за текущий неполный день не возвращаются. Если вам необходимо получить записи за текущий день, следует использовать таблицы необработанных данных LA.
Список системных функций
Функции в модуле Core
_AzureBackup_GetVaults()
Эта функция возвращает список всех хранилищ Служб восстановления в среде Azure, связанных с рабочей областью LA.
Параметры
Имя параметра | Описание | Обязательный? | Пример значения | Data type |
---|---|---|---|---|
RangeStart | Используйте этот параметр вместе с параметром RangeEnd, только если необходимо получить все записи, относящиеся к хранилищу, за период времени с RangeStart по RangeEnd. По умолчанию RangeStart и RangeEnd имеют значение NULL, вследствие чего функция извлечет только последнюю запись для каждого хранилища. | Нет | "2021-03-03 00:00:00" | Дата и время |
RangeEnd | Используйте этот параметр вместе с параметром RangeStart, только если необходимо получить все записи, относящиеся к хранилищу, за период времени с RangeStart по RangeEnd. По умолчанию RangeStart и RangeEnd имеют значение NULL, вследствие чего функция извлечет только последнюю запись для каждого хранилища. | Нет | "2021-03-10 00:00:00" | Дата и время |
VaultSubscriptionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора подписок, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую идентификаторы подписок, это позволит получить только те хранилища, которые находятся в указанных подписках. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех подписках. | Нет | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | Строковый тип |
VaultLocationList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора регионов, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую регионы, это позволит получить только те хранилища, которые находятся в указанных регионах. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех регионах. | Нет | eastus,westus |
Строка |
VaultList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора хранилищ. Если в качестве параметра этой функции указать перечисленные через запятую имена хранилищ, это позволит получить только те записи, которые относятся к указанным хранилищам. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех хранилищах. | Нет | vault1,vault2,vault3 |
Строка |
VaultTypeList | Используйте этот параметр, чтобы отфильтровать выходные данные функции по записям, относящимся к хранилищам конкретного типа. По умолчанию этот параметр имеет значение "*", что делает функцию поиска хранилищ служб восстановления и хранилищ резервных копий. | Нет | Microsoft.RecoveryServices/vaults | Строка |
ExcludeLegacyEvent | Используйте этот параметр, чтобы выбрать, запрашивать ли данные в устаревшей таблице AzureDiagnostics или нет. Если значение этого параметра — false, функция запрашивает данные как из таблицы AzureDiagnostics, так и из таблиц для конкретных ресурсов. Если значение этого параметра — true, функция запрашивает данные только из таблиц для конкретных ресурсов. Значение по умолчанию — true. | Нет | Да | Логическое |
Возвращаемые поля
Имя поля | Описание | Data type |
---|---|---|
UniqueId | Первичный ключ, обозначающий уникальный идентификатор хранилища | Строка |
Идентификатор | Идентификатор Azure Resource Manager (ARM) хранилища | Строка |
Имя | Имя хранилища | Строковый тип |
SubscriptionId | Идентификатор подписки, в которой существует хранилище | Строковый тип |
Расположение | Расположение, в котором существует хранилище | Строковый тип |
VaultStore_StorageReplicationType | Тип репликации службы хранилища, связанный с хранилищем | Строковый тип |
Теги | Теги хранилища | Строковый тип |
TimeGenerated | Метка времени записи | Дата и время |
Тип | Тип хранилища, например Microsoft.RecoveryServices/vaults или Microsoft.DataProtection/backupVaults. | Строковый тип |
_AzureBackup_GetPolicies()
Эта функция возвращает список политик резервного копирования, используемых в среде Azure, а также подробные сведения о каждой политике, такие как тип источника данных, тип репликации службы хранилища и т. д.
Параметры
Имя параметра | Описание | Обязательный? | Пример значения | Data type |
---|---|---|---|---|
RangeStart | Используйте этот параметр вместе с параметром RangeStart, только если необходимо получить все записи, относящиеся к политике, за период времени с RangeStart по RangeEnd. По умолчанию RangeStart и RangeEnd имеют значение NULL, вследствие чего функция извлечет только последнюю запись для каждой политики. | Нет | "2021-03-03 00:00:00" | Дата и время |
RangeEnd | Используйте этот параметр вместе с параметром RangeStart, только если необходимо получить все записи, относящиеся к политике, за период времени с RangeStart по RangeEnd. По умолчанию RangeStart и RangeEnd имеют значение NULL, вследствие чего функция извлечет только последнюю запись для каждой политики. | Нет | "2021-03-10 00:00:00" | Дата и время |
VaultSubscriptionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора подписок, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую идентификаторы подписок, это позволит получить только те политики, которые находятся в указанных подписках. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех подписках. | Нет | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | Строка |
VaultLocationList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора регионов, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую регионы, это позволит получить только те политики, которые находятся в указанных регионах. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех регионах. | Нет | eastus,westus |
Строка |
VaultList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора хранилищ. Если в качестве параметра этой функции указать перечисленные через запятую имена хранилищ, это позволит получить только те записи политик, которые относятся к указанным хранилищам. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей политик во всех хранилищах. | Нет | vault1,vault2,vault3 |
Строка |
VaultTypeList | Используйте этот параметр, чтобы отфильтровать выходные данные функции по записям, относящимся к хранилищам конкретного типа. По умолчанию этот параметр имеет значение "*", поэтому функция выполняет поиск хранилищ служб восстановления и хранилищ резервных копий. | Нет | Microsoft.RecoveryServices/vaults | Строковый тип |
ExcludeLegacyEvent | Используйте этот параметр, чтобы выбрать, запрашивать ли данные в устаревшей таблице AzureDiagnostics или нет. Если значение этого параметра — false, функция запрашивает данные как из таблицы AzureDiagnostics, так и из таблиц для конкретных ресурсов. Если значение этого параметра — true, функция запрашивает данные только из таблиц для конкретных ресурсов. Значение по умолчанию — true. | Нет | Да | Логическое |
BackupSolutionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора решений резервного копирования, используемых в среде Azure. Например, если указать Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM в качестве значения этого параметра, функция возвращает только записи, связанные с элементами, резервными копиями которых является резервное копирование виртуальной машины Azure, SQL в резервном копировании виртуальных машин Azure или DPM в Azure Backup. По умолчанию этот параметр имеет значение "*", что делает функцию возвращающей записи, относящиеся ко всем решениям резервного копирования, поддерживаемым отчетами о резервном копировании (поддерживаемые значения: "Azure Virtual Machine Backup", "SQL in Azure VM Backup", "SAP HANA in Azure VM Backup", "Azure Storage (Файлы Azure) Backup", "Azure Backup Agent", "DPM", "Azure Backup Server", " База данных Azure для PostgreSQL Резервное копирование сервера", "Резервное копирование BLOB-объектов Azure", "Резервное копирование дисков Azure" или сочетание любого из этих значений, разделенных запятыми). |
Нет | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
Строка |
Возвращаемые поля
Имя поля | Описание | **Тип данных ** |
---|---|---|
UniqueId | Первичный ключ, обозначающий уникальный идентификатор политики | Строка |
Идентификатор | Идентификатор Azure Resource Manager (ARM) политики | Строка |
Имя | Имя политики | Строка |
TimeZone | Часовой пояс, в котором определена политика | Строковый тип |
Решение резервного копирования | Решение резервного копирования, с которым связана политика. Например, резервное копирование виртуальных машин Azure, резервное копирование SQL на виртуальной машине Azure и т. д. | Строка |
TimeGenerated | Метка времени записи | Datetime |
VaultUniqueId | Внешний ключ, ссылающийся на хранилище, которое связано с политикой | Строковый тип |
VaultResourceId | Идентификатор Azure Resource Manager (ARM) хранилища, связанного с политикой | Строка |
Vaultname | Имя хранилища, связанного с политикой | Строка |
VaultTags | Теги хранилища, связанные с политикой | Строковый тип |
VaultLocation | Расположение хранилища, связанного с политикой | Строковый тип |
VaultSubscriptionId | Идентификатор подписки хранилища, связанного с политикой | Строковый тип |
VaultStore_StorageReplicationType | Тип репликации службы хранилища, связанного с политикой | Строковый тип |
VaultType | Тип хранилища, например Microsoft.RecoveryServices/vaults или Microsoft.DataProtection/backupVaults. | Строковый тип |
ExtendedProperties | Дополнительные свойства политики | Динамический |
_AzureBackup_GetJobs()
Эта функция возвращает список всех заданий, связанных с резервным копированием и восстановлением и активированных в указанный диапазон времени, а также подробные сведения о каждом задании, такие как состояние задания, длительность задания, переданные данные и т. д.
Параметры
Имя параметра | Описание | Обязательный? | Пример значения | **Тип данных ** |
---|---|---|---|---|
RangeStart | Используйте этот параметр вместе с параметром RangeEnd, чтобы получить список всех заданий, запущенных за период времени с RangeStart по RangeEnd. | Да | "2021-03-03 00:00:00" | Дата и время |
RangeEnd | Используйте этот параметр вместе с параметром RangeStart, чтобы получить список всех заданий, запущенных за период времени с RangeStart по RangeEnd. | Да | "2021-03-10 00:00:00" | Дата и время |
VaultSubscriptionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора подписок, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую идентификаторы подписок, это позволит получить только те задания, которые связаны с хранилищами в указанных подписках. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех подписках. | Нет | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | Строковый тип |
VaultLocationList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора регионов, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую регионы, это позволит получить только те задания, которые связаны с хранилищами в указанных регионах. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех регионах. | Нет | eastus,westus |
Строка |
VaultList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора хранилищ. Если в качестве параметра этой функции указать перечисленные через запятую имена хранилищ, это позволит получить только те задания, которые относятся к указанным хранилищам. По умолчанию значение этого параметра — "*", вследствие чего функция выполняет поиск заданий во всех хранилищах. | Нет | vault1,vault2,vault3 |
Строка |
VaultTypeList | Используйте этот параметр, чтобы отфильтровать выходные данные функции по записям, относящимся к хранилищам конкретного типа. По умолчанию этот параметр имеет значение "*", поэтому функция выполняет поиск хранилищ служб восстановления и хранилищ резервных копий. | Нет | Microsoft.RecoveryServices/vaults | Строковый тип |
ExcludeLegacyEvent | Используйте этот параметр, чтобы выбрать, запрашивать ли данные в устаревшей таблице AzureDiagnostics или нет. Если значение этого параметра — false, функция запрашивает данные как из таблицы AzureDiagnostics, так и из таблиц для конкретных ресурсов. Если значение этого параметра — true, функция запрашивает данные только из таблиц для конкретных ресурсов. Значение по умолчанию — true. | Нет | Да | Логическое |
BackupSolutionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора решений резервного копирования, используемых в среде Azure. Например, если указать Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM в качестве значения этого параметра, функция возвращает только записи, связанные с элементами, резервными копиями которых является резервное копирование виртуальной машины Azure, SQL в резервном копировании виртуальных машин Azure или DPM в Azure Backup. По умолчанию этот параметр имеет значение "*", что делает функцию возвращающей записи, относящиеся ко всем решениям резервного копирования, поддерживаемым отчетами о резервном копировании (поддерживаемые значения: "Azure Virtual Machine Backup", "SQL in Azure VM Backup", "SAP HANA in Azure VM Backup", "Azure Storage (Файлы Azure) Backup", "Azure Backup Agent", "DPM", "Azure Backup Server", " База данных Azure для PostgreSQL Резервное копирование сервера", "Резервное копирование BLOB-объектов Azure", "Резервное копирование дисков Azure" или сочетание любого из этих значений, разделенных запятыми). |
Нет | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
Строка |
JobOperationList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для конкретного типа заданий. Например, резервное копирование или восстановление. По умолчанию значение этого параметра — "*", вследствие чего функция выполняет поиск заданий как резервного копирования, так и восстановления. | Нет | Backup | Строка |
JobStatusList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для конкретного состояния заданий. Например, "Завершено", "Ошибка" и т. д. По умолчанию значение этого параметра — "*", вследствие чего функция выполняет поиск всех заданий независимо от состояния. | Нет | Failed,CompletedWithWarnings |
Строка |
JobFailureCodeList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для конкретного кода ошибки. По умолчанию значение этого параметра — "*", вследствие чего функция выполняет поиск всех заданий независимо от кода ошибки. | Нет | Success | Строка |
DatasourceSetName | Используйте этот параметр, чтобы отфильтровать выходные данные функции по конкретному родительскому ресурсу. Например, чтобы вернуть экземпляры резервной копии SQL на виртуальной машине Azure, принадлежащие виртуальной машине testvm, укажите testvm в качестве значения этого параметра. По умолчанию значение — "*", вследствие чего функция выполняет поиск записей во всех экземплярах резервной копии. | Нет | testvm | Строка |
BackupInstanceName | Используйте этот параметр для поиска заданий в определенном экземпляре резервной копии по имени. По умолчанию значение — "*", вследствие чего функция выполняет поиск записей во всех экземплярах резервной копии. | Нет | testvm | Строка |
ExcludeLog | Используйте этот параметр, чтобы исключить задания журнала из числа возвращаемых функцией результатов (помогает повысить производительность запроса). По умолчанию значение этого параметра — true, что вследствие чего функция исключает задания журнала. | Нет | Да | Логическое |
Возвращаемые поля
Имя поля | Описание | **Тип данных ** |
---|---|---|
UniqueId | Первичный ключ, обозначающий уникальный идентификатор задания | Строка |
OperationCategory | Категория выполняемой операции. Например, резервное копирование, восстановление | Строка |
Операция | Сведения о выполняемой операции. Например, Log (для резервной копии журналов) | Строка |
Состояние | Состояние задания. Например, Completed, Failed, CompletedWithWarnings | Строка |
ErrorTitle | Код ошибки задания | Строковый тип |
StartTime | Дата и время запуска задания | Дата и время |
DurationInSecs | Длительность задания в секундах | Double |
DataTransferredInMBs | Данные, передаваемые заданием в МБ. В настоящее время это поле поддерживается только для рабочих нагрузок хранилища Служб восстановления. | Double |
RestoreJobRPDateTime | Дата и время создания восстанавливаемой точки восстановления. В настоящее время это поле поддерживается только для рабочих нагрузок хранилища Служб восстановления. | Дата и время |
RestoreJobRPLocation | Место хранения восстанавливаемой точки восстановления | Строковый тип |
BackupInstanceUniqueId | Внешний ключ, который ссылается на экземпляр резервной копии, связанный с заданием | Строковый тип |
BackupInstanceId | Идентификатор Azure Resource Manager (ARM) экземпляра резервной копии, связанного с заданием | Строковый тип |
BackupInstanceFriendlyName | Имя экземпляра резервной копии, связанного с заданием | Строковый тип |
DatasourceResourceId | Идентификатор Azure Resource Manager (ARM) базового источника данных, связанного с заданием. Например, идентификатор Azure Resource Manager (ARM) виртуальной машины | Строковый тип |
DatasourceFriendlyName | Понятное имя базового источника данных, связанного с заданием | Строковый тип |
DatasourceType | Тип источника данных, связанного с заданием. Например, Microsoft.Compute/virtualMachines | Строковый тип |
BackupSolution | Решение резервного копирования, с которым связано задание. Например, резервное копирование виртуальных машин Azure, резервное копирование SQL на виртуальной машине Azure и т. д. | Строковый тип |
DatasourceSetResourceId | Идентификатор Azure Resource Manager (ARM) родительского ресурса источника данных (когда применимо). Например, для источника данных SQL на виртуальной машине Azure это поле будет содержать идентификатор Azure Resource Manager (ARM) виртуальной машины, на которой существует База данных SQL. | Строковый тип |
DatasourceSetType | Тип родительского ресурса источника данных (когда применимо). Например, для источника данных SAP HANA на виртуальной машине Azure это поле будет иметь значение Microsoft.Compute/virtualMachines, так как родительский ресурс — виртуальная машина Azure | Строковый тип |
VaultResourceId | Идентификатор Azure Resource Manager (ARM) хранилища, связанного с заданием | Строковый тип |
VaultUniqueId | Внешний ключ, ссылающийся на хранилище, которое связано с заданием | Строковый тип |
Vaultname | Имя хранилища, связанного с заданием | Строковый тип |
VaultTags | Тип хранилища, связанного с заданием | Строка |
VaultSubscriptionId | Идентификатор подписки хранилища, связанного с заданием | Строка |
VaultLocation | Расположение хранилища, связанного с заданием | Строковый тип |
VaultStore_StorageReplicationType | Тип репликации службы хранилища, связанного с заданием | Строковый тип |
VaultType | Тип хранилища, например Microsoft.RecoveryServices/vaults или Microsoft.DataProtection/backupVaults. | Строковый тип |
TimeGenerated | Метка времени записи | Дата и время |
_AzureBackup_GetBackupInstances()
Эта функция возвращает список экземпляров резервной копии, связанных с хранилищами Служб восстановления, а также подробные сведения о каждом экземпляре резервной копии, такие как потребление облачного хранилища, связанная политика и т. д.
Параметры
Имя параметра | Описание | Обязательный? | Пример значения | **Тип данных ** |
---|---|---|---|---|
RangeStart | Используйте этот параметр вместе с параметром RangeEnd, только если необходимо получить все записи, относящиеся к экземпляру резервной копии, за период времени с RangeStart по RangeEnd. По умолчанию RangeStart и RangeEnd имеют значение NULL, вследствие чего функция извлечет только последнюю запись для каждого экземпляра резервной копии. | Нет | "2021-03-03 00:00:00" | DataTime |
RangeEnd | Используйте этот параметр вместе с параметром RangeStart, только если необходимо получить все записи, относящиеся к экземпляру резервной копии, за период времени с RangeStart по RangeEnd. По умолчанию RangeStart и RangeEnd имеют значение NULL, вследствие чего функция извлечет только последнюю запись для каждого экземпляра резервной копии. | Нет | "2021-03-10 00:00:00" | Дата и время |
VaultSubscriptionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора подписок, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую идентификаторы подписок, это позволит получить только те экземпляры резервной копии, которые находятся в указанных подписках. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех подписках. | Нет | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | Строковый тип |
VaultLocationList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора регионов, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую регионы, это позволит получить только те экземпляры резервной копии, которые находятся в указанных регионах. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех регионах. | Нет | eastus,westus |
Строка |
VaultList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора хранилищ. Если в качестве параметра этой функции указать перечисленные через запятую имена хранилищ, это позволит получить только те записи экземпляров резервной копии, которые относятся к указанным хранилищам. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей экземпляров резервной копии во всех хранилищах. | Нет | vault1,vault2,vault3 |
Строка |
VaultTypeList | Используйте этот параметр, чтобы отфильтровать выходные данные функции по записям, относящимся к хранилищам конкретного типа. По умолчанию этот параметр имеет значение "*", что делает функцию поиска хранилищ служб восстановления и хранилищ резервных копий. | Нет | Microsoft.RecoveryServices/vaults | Строковый тип |
ExcludeLegacyEvent | Используйте этот параметр, чтобы выбрать, запрашивать ли данные в устаревшей таблице AzureDiagnostics или нет. Если значение этого параметра — false, функция запрашивает данные как из таблицы AzureDiagnostics, так и из таблиц для конкретных ресурсов. Если значение этого параметра — true, функция запрашивает данные только из таблиц для конкретных ресурсов. Значение по умолчанию — true. | Нет | Да | Логическое |
BackupSolutionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора решений резервного копирования, используемых в среде Azure. Например, если указать Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM в качестве значения этого параметра, функция возвращает только записи, связанные с элементами, резервными копиями которых является резервное копирование виртуальных машин Azure, SQL в резервном копировании виртуальных машин Azure или DPM в Azure Backup. По умолчанию этот параметр имеет значение "*", что делает функцию возвращающей записи, относящиеся ко всем решениям резервного копирования, поддерживаемым отчетами о резервном копировании (поддерживаемые значения: "Резервное копирование виртуальных машин Azure", "SQL в резервном копировании виртуальных машин Azure", "SAP HANA в службе архивации виртуальных машин Azure", "Резервное копирование хранилища Azure (Файлы Azure)", "агент Azure Backup", "DPM", "Azure Backup Server", " База данных Azure для PostgreSQL Резервное копирование сервера", "Резервное копирование BLOB-объектов Azure", "Резервное копирование дисков Azure" или сочетание этих значений с разделим запятыми). |
Нет | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
Строка |
ProtectionInfoList | Используйте этот параметр, чтобы указать, следует ли включить только активно защищаемые экземпляры резервной копии или же также включить экземпляры, защита которых остановлена, и экземпляры, ожидающие начального резервного копирования. Для рабочих нагрузок хранилища служб восстановления поддерживаются следующие значения: "Protected", "ProtectionStopped", "InitialBackupPending" или сочетание этих значений, разделенных запятыми. Для рабочих нагрузок хранилища резервных копий поддерживаются следующие значения: "Protected", "ConfiguringProtection", "ConfiguringProtectionFailed", "UpdatingProtection", "ProtectionError", "ProtectionStopped" или сочетание этих значений с разделителями-запятыми. По умолчанию значение — "*", вследствие чего функция выполняет поиск всех экземпляров резервной копии независимо от сведений о защите. | Нет | Protected | Строковый тип |
DatasourceSetName | Используйте этот параметр, чтобы отфильтровать выходные данные функции по конкретному родительскому ресурсу. Например, чтобы вернуть экземпляры резервной копии SQL на виртуальной машине Azure, принадлежащие виртуальной машине testvm, укажите testvm в качестве значения этого параметра. По умолчанию значение — "*", вследствие чего функция выполняет поиск записей во всех экземплярах резервной копии. | Нет | testvm | Строка |
BackupInstanceName | Используйте этот параметр для поиска определенного экземпляра резервной копии по имени. По умолчанию значение — "*", вследствие чего функция выполняет поиск всех экземпляров резервной копии. | Нет | testvm | Строковый тип |
DisplayAllFields | Используйте этот параметр, чтобы указать, следует ли извлекать только подмножество полей, возвращаемых функцией. Если значение этого параметра — false, функция исключает сведения о хранилище и точке хранения из выходных данных функции. Это полезно, если данная функция используется в качестве промежуточного шага в составе более крупного запроса и требуется оптимизировать производительность запроса путем исключения столбцов, не требующихся для анализа. По умолчанию значение этого параметра — true, вследствие чего функция возвращает все поля, относящиеся к экземпляру резервной копии. | Нет | Да | Логическое |
Возвращаемые поля
Имя поля | Описание | Data type |
---|---|---|
UniqueId | Первичный ключ, обозначающий уникальный идентификатор экземпляра резервной копии | Строка |
Идентификатор | Идентификатор Azure Resource Manager (ARM) экземпляра резервной копии | Строка |
FriendlyName | Понятное имя экземпляра резервной копии | Строковый тип |
ProtectionInfo | Сведения о параметрах защиты экземпляра резервной копии. Например, защита настроена, защита остановлена, начальное резервное копирование ожидается | Строковый тип |
LatestRecoveryPoint | Дата и время последней точки восстановления, связанной с экземпляром резервной копии. В настоящее время это поле поддерживается только для рабочих нагрузок хранилища Служб восстановления. | Дата и время |
OldestRecoveryPoint | Дата и время самой старой точки восстановления, связанной с экземпляром резервной копии. В настоящее время это поле поддерживается только для рабочих нагрузок хранилища Служб восстановления. | Дата и время |
SourceSizeInMBs | Внешний размер экземпляра резервной копии в МБ | Double |
VaultStore_StorageConsumptionInMBs | Общий объем облачного хранилища, использованного экземпляром резервной копии на стандартном уровне хранилища | Double |
DataSourceFriendlyName | Понятное имя источника данных, соответствующего экземпляру резервной копии | Строковый тип |
BackupSolution | Решение резервного копирования, с которым связан экземпляр резервной копии. Например, резервное копирование виртуальных машин Azure, резервное копирование SQL на виртуальной машине Azure и т. д. | Строковый тип |
DatasourceType | Тип источника данных, соответствующего экземпляру резервной копии. Например, Microsoft.Compute/virtualMachines | Строка |
DatasourceResourceId | Идентификатор Azure Resource Manager (ARM) базового источника данных, соответствующего экземпляру резервной копии. Например, идентификатор Azure Resource Manager (ARM) виртуальной машины | Строка |
DatasourceSetFriendlyName | Понятное имя родительского ресурса источника данных (когда применимо). Например, для источника данных SQL на виртуальной машине Azure это поле будет содержать имя виртуальной машины, на которой существует База данных SQL | Строка |
DatasourceSetFriendlyName | Понятное имя родительского ресурса источника данных (когда применимо). Например, для источника данных SQL на виртуальной машине Azure это поле будет содержать имя виртуальной машины, на которой существует База данных SQL | Строка |
DatasourceSetResourceId | Идентификатор Azure Resource Manager (ARM) родительского ресурса источника данных (когда применимо). Например, для источника данных SQL на виртуальной машине Azure это поле будет содержать идентификатор Azure Resource Manager (ARM) виртуальной машины, на которой существует База данных SQL. | Строка |
DatasourceSetType | Тип родительского ресурса источника данных (когда применимо). Например, для источника данных SAP HANA на виртуальной машине Azure это поле будет иметь значение Microsoft.Compute/virtualMachines, так как родительский ресурс — виртуальная машина Azure | Строка |
PolicyName | Имя политики, связанной с экземпляром резервной копии | Строковый тип |
PolicyUniqueId | Внешний ключ, который ссылается на политику, связанную с экземпляром резервной копии | Строковый тип |
PolicyId | Идентификатор Azure Resource Manager (ARM) политики, связанной с экземпляром резервной копии | Строковый тип |
VaultResourceId | Идентификатор Azure Resource Manager (ARM) хранилища, связанного с экземпляром резервной копии | Строка |
VaultUniqueId | Внешний ключ, который ссылается на хранилище, связанное с экземпляром резервной копии | Строка |
Vaultname | Имя хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultTags | Теги хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultSubscriptionId | Идентификатор подписки хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultLocation | Расположение хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultStore_StorageReplicationType | Тип репликации службы хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultType | Тип хранилища: Microsoft.RecoveryServices/vaults или Microsoft.DataProtection/backupVaults. | Строка |
TimeGenerated | Метка времени записи | Дата и время |
_AzureBackup_GetBillingGroups()
Эта функция возвращает список всех сущностей выставления счетов, связанных с резервной копией (групп выставления счетов), а также сведения о ключевых компонентах выставления счетов, таких как размер интерфейсной части и общий объем облачного хранилища.
Параметры
Имя параметра | Описание | Обязательный? | Пример значения | Тип DATE |
---|---|---|---|---|
RangeStart | Используйте этот параметр вместе с параметром RangeEnd, только если необходимо получить все записи, относящиеся к группе выставления счетов, за период времени с RangeStart по RangeEnd. По умолчанию RangeStart и RangeEnd имеют значение NULL, вследствие чего функция извлечет только последнюю запись для каждой группы выставления счетов. | Нет | "2021-03-03 00:00:00" | Дата и время |
RangeEnd | Используйте этот параметр вместе с параметром RangeStart, только если необходимо получить все записи, относящиеся к группе выставления счетов, за период времени с RangeStart по RangeEnd. По умолчанию RangeStart и RangeEnd имеют значение NULL, вследствие чего функция извлечет только последнюю запись для каждой группы выставления счетов. | Нет | "2021-03-10 00:00:00" | Дата и время |
VaultSubscriptionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора подписок, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую идентификаторы подписок, это позволит получить только те группы выставления счетов, которые находятся в указанных подписках. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех подписках. | Нет | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | Строковый тип |
VaultLocationList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора регионов, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую регионы, это позволит получить только те группы выставления счетов, которые находятся в указанных регионах. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех регионах. | Нет | eastus,westus |
Строка |
VaultList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора хранилищ. Если в качестве параметра этой функции указать перечисленные через запятую имена хранилищ, это позволит получить только те записи экземпляров резервной копии, которые относятся к указанным хранилищам. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей групп выставления счетов во всех хранилищах. | Нет | vault1,vault2,vault3 |
Строка |
VaultTypeList | Используйте этот параметр, чтобы отфильтровать выходные данные функции по записям, относящимся к хранилищам конкретного типа. По умолчанию этот параметр имеет значение "*", что делает функцию поиска хранилищ служб восстановления и хранилищ резервных копий. | Нет | Microsoft.RecoveryServices/vaults | Строковый тип |
ExcludeLegacyEvent | Используйте этот параметр, чтобы выбрать, запрашивать ли данные в устаревшей таблице AzureDiagnostics или нет. Если значение этого параметра — false, функция запрашивает данные как из таблицы AzureDiagnostics, так и из таблиц для конкретных ресурсов. Если значение этого параметра — true, функция запрашивает данные только из таблиц для конкретных ресурсов. Значение по умолчанию — true. | Нет | Да | Логическое |
BackupSolutionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора решений резервного копирования, используемых в среде Azure. Например, если указать Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM в качестве значения этого параметра, функция возвращает только записи, связанные с элементами, резервными копиями которых является резервное копирование виртуальных машин Azure, SQL в резервном копировании виртуальных машин Azure или DPM в Azure Backup. По умолчанию этот параметр имеет значение "*", что делает функцию возвращающей записи, относящиеся ко всем решениям резервного копирования, поддерживаемым отчетами о резервном копировании (поддерживаемые значения: "Резервное копирование виртуальных машин Azure", "SQL в резервном копировании виртуальных машин Azure", "SAP HANA в службе архивации виртуальных машин Azure", "Резервное копирование хранилища Azure (Файлы Azure)", "агент Azure Backup", "DPM", "Azure Backup Server", " База данных Azure для PostgreSQL Резервное копирование сервера", "Резервное копирование BLOB-объектов Azure", "Резервное копирование дисков Azure" или сочетание этих значений с разделим запятыми). |
Нет | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
Строка |
BillingGroupName | Используйте этот параметр для поиска определенной группы выставления счетов. По умолчанию значение — "*", вследствие чего функция выполняет поиск всех групп выставления счетов. | Нет | testvm | Строковый тип |
Возвращаемые поля
Имя поля | Описание | Data type |
---|---|---|
UniqueId | Первичный ключ, обозначающий уникальный идентификатор группы выставления счетов | Строковый тип |
FriendlyName | Понятное имя группы выставления счетов | Строка |
Имя | Имя группы выставления счетов. | Строка |
Тип | Тип группы выставления счетов. Например, ProtectedContainer или BackupItem | Строковый тип |
SourceSizeInMBs | Размер интерфейсной части группы выставления счетов в МБ | Double |
VaultStore_StorageConsumptionInMBs | Общий объем облачного хранилища, использованного группой выставления счетов на стандартном уровне хранилища | Double |
BackupSolution | Решение резервного копирования, с которым связана группа выставления счетов. Например, резервное копирование виртуальных машин Azure, резервное копирование SQL на виртуальной машине Azure и т. д. | Строковый тип |
VaultResourceId | Идентификатор Azure Resource Manager (ARM) хранилища, связанного с группой выставления счетов | Строковый тип |
VaultUniqueId | Внешний ключ, который ссылается на хранилище, связанное с группой выставления счетов | Строка |
Vaultname | Имя хранилища, связанного с группой выставления счетов | Строковый тип |
VaultTags | Теги хранилища, связанного с группой выставления счетов | Строковый тип |
VaultSubscriptionId | Идентификатор подписки хранилища, связанного с группой выставления счетов | Строковый тип |
VaultLocation | Расположение хранилища, связанного с группой выставления счетов | Строковый тип |
VaultStore_StorageReplicationType | Тип репликации службы хранилища, связанного с группой выставления счетов | Строковый тип |
VaultType | Тип хранилища, например Microsoft.RecoveryServices/vaults или Microsoft.DataProtection/backupVaults. | Строковый тип |
TimeGenerated | Метка времени записи | Дата и время |
ExtendedProperties | Дополнительные свойства группы выставления счетов | Динамический |
Функции тренда
_AzureBackup_GetBackupInstancesTrends()
Эта функция возвращает исторические записи для каждого экземпляра резервной копии, что позволяет просматривать ключевые ежедневные, еженедельные и ежемесячные тенденции, связанные с количеством экземпляров резервных копий и потреблением хранилища, на нескольких уровнях детализации.
Параметры
Имя параметра | Описание | Обязательный? | Пример значения | Data type |
---|---|---|---|---|
RangeStart | Используйте этот параметр вместе с параметром RangeEnd для получения всех записей, относящихся к экземпляру резервной копии, за период времени с RangeStart по RangeEnd. | Да | "2021-03-03 00:00:00" | Дата и время |
RangeEnd | Используйте этот параметр вместе с параметром RangeStart для получения всех записей, относящихся к экземпляру резервной копии, за период времени с RangeStart по RangeEnd. | Да | "2021-03-10 00:00:00" | Дата и время |
VaultSubscriptionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора подписок, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую идентификаторы подписок, это позволит получить только те экземпляры резервной копии, которые находятся в указанных подписках. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех подписках. | Нет | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | Строковый тип |
VaultLocationList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора регионов, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую регионы, это позволит получить только те экземпляры резервной копии, которые находятся в указанных регионах. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех регионах. | Нет | eastus,westus |
Строка |
VaultList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора хранилищ. Если в качестве параметра этой функции указать перечисленные через запятую имена хранилищ, это позволит получить только те записи экземпляров резервной копии, которые относятся к указанным хранилищам. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей экземпляров резервной копии во всех хранилищах. | Нет | vault1,vault2,vault3 |
Строка |
VaultTypeList | Используйте этот параметр, чтобы отфильтровать выходные данные функции по записям, относящимся к хранилищам конкретного типа. По умолчанию этот параметр имеет значение "*", поэтому функция выполняет поиск хранилищ служб восстановления и хранилищ резервных копий. | Нет | Microsoft.RecoveryServices/vaults | Строковый тип |
ExcludeLegacyEvent | Используйте этот параметр, чтобы выбрать, запрашивать ли данные в устаревшей таблице AzureDiagnostics или нет. Если значение этого параметра — false, функция запрашивает данные как из таблицы AzureDiagnostics, так и из таблиц для конкретных ресурсов. Если значение этого параметра — true, функция запрашивает данные только из таблиц для конкретных ресурсов. Значение по умолчанию — true. | Нет | Да | Логическое |
BackupSolutionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора решений резервного копирования, используемых в среде Azure. Например, если указать Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM в качестве значения этого параметра, функция возвращает только записи, связанные с элементами, резервными копиями которых является резервное копирование виртуальной машины Azure, SQL в резервном копировании виртуальных машин Azure или DPM в Azure Backup. По умолчанию этот параметр имеет значение "*", что делает функцию возвращающей записи, относящиеся ко всем решениям резервного копирования, поддерживаемым отчетами о резервном копировании (поддерживаемые значения: "Azure Virtual Machine Backup", "SQL in Azure VM Backup", "SAP HANA in Azure VM Backup", "Azure Storage (Файлы Azure) Backup", "Azure Backup Agent", "DPM", "Azure Backup Server", " База данных Azure для PostgreSQL Резервное копирование сервера", "Резервное копирование BLOB-объектов Azure", "Резервное копирование дисков Azure" или сочетание любого из этих значений, разделенных запятыми). |
Нет | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
Строка |
ProtectionInfoList | Используйте этот параметр, чтобы указать, следует ли включить только активно защищаемые экземпляры резервной копии или же также включить экземпляры, защита которых остановлена, и экземпляры, ожидающие начального резервного копирования. Для рабочих нагрузок хранилища служб восстановления поддерживаются следующие значения: "Protected", "ProtectionStopped", "InitialBackupPending" или сочетание любого из этих значений, разделенное запятыми. Для рабочих нагрузок хранилища резервных копий поддерживаются следующие значения: "Protected", "ConfiguringProtection", "ConfiguringProtectionFailed", "UpdatingProtection", "ProtectionError", "ProtectionStopped" или сочетание любого из этих значений с разделителями-запятыми. По умолчанию значение — "*", вследствие чего функция выполняет поиск всех экземпляров резервной копии независимо от сведений о защите. | Нет | Protected | Строковый тип |
DatasourceSetName | Используйте этот параметр, чтобы отфильтровать выходные данные функции по конкретному родительскому ресурсу. Например, чтобы вернуть экземпляры резервной копии SQL на виртуальной машине Azure, принадлежащие виртуальной машине testvm, укажите testvm в качестве значения этого параметра. По умолчанию значение — "*", вследствие чего функция выполняет поиск записей во всех экземплярах резервной копии. | Нет | testvm | Строковый тип |
BackupInstanceName | Используйте этот параметр для поиска определенного экземпляра резервной копии по имени. По умолчанию значение — "*", вследствие чего функция выполняет поиск всех экземпляров резервной копии. | Нет | testvm | Строка |
DisplayAllFields | Используйте этот параметр, чтобы указать, следует ли извлекать только подмножество полей, возвращаемых функцией. Если значение этого параметра — false, функция исключает сведения о хранилище и точке хранения из выходных данных функции. Это полезно, если данная функция используется в качестве промежуточного шага в составе более крупного запроса и требуется оптимизировать производительность запроса путем исключения столбцов, не требующихся для анализа. По умолчанию значение этого параметра — true, вследствие чего функция возвращает все поля, относящиеся к экземпляру резервной копии. | Нет | Да | Логическое |
AggregationType | Используйте этот параметр, чтобы указать степень детализации времени, данные за которое необходимо получить. Если значение этого параметра — Daily, функция возвращает запись для каждого экземпляра резервной копии за каждый день, что позволяет анализировать ежедневные тенденции использования хранилища и количества экземпляров резервной копии. Если значение этого параметра — Weekly, функция возвращает запись для каждого экземпляра резервной копии за каждую неделю, что позволяет анализировать еженедельные тенденции. Аналогичным образом можно указать Monthly для анализа ежемесячных тенденций. Значение по умолчанию — Daily. При просмотре данных за более длительные диапазоны времени рекомендуется использовать значение Weekly или Monthly для повышения производительности запроса и упрощения анализа тенденций. | Нет | Weekly | Строка |
Возвращаемые поля
Имя поля | Описание | Data type |
---|---|---|
UniqueId | Первичный ключ, обозначающий уникальный идентификатор экземпляра резервной копии | Строка |
Идентификатор | Идентификатор Azure Resource Manager (ARM) экземпляра резервной копии | Строка |
FriendlyName | Понятное имя экземпляра резервной копии | Строка |
ProtectionInfo | Сведения о параметрах защиты экземпляра резервной копии. Например, защита настроена, защита остановлена, начальное резервное копирование ожидается | Строка |
LatestRecoveryPoint | Дата и время последней точки восстановления, связанной с экземпляром резервной копии. В настоящее время это поле поддерживается только для рабочих нагрузок хранилища Служб восстановления. | Дата и время |
OldestRecoveryPoint | Дата и время первой точки восстановления, связанной с экземпляром резервной копии | В настоящее время это поле поддерживается только для рабочих нагрузок хранилища Служб восстановления. |
SourceSizeInMBs | Внешний размер экземпляра резервной копии в МБ | Double |
VaultStore_StorageConsumptionInMBs | Общий объем облачного хранилища, использованного экземпляром резервной копии на стандартном уровне хранилища | Double |
DataSourceFriendlyName | Понятное имя источника данных, соответствующего экземпляру резервной копии | Строковый тип |
BackupSolution | Решение резервного копирования, с которым связан экземпляр резервной копии. Например, резервное копирование виртуальных машин Azure, резервное копирование SQL на виртуальной машине Azure и т. д. | Строковый тип |
DatasourceType | Тип источника данных, соответствующего экземпляру резервной копии. Например, Microsoft.Compute/virtualMachines | Строковый тип |
DatasourceResourceId | Идентификатор Azure Resource Manager (ARM) базового источника данных, соответствующего экземпляру резервной копии. Например, идентификатор Azure Resource Manager (ARM) виртуальной машины | Строковый тип |
DatasourceSetFriendlyName | Понятное имя родительского ресурса источника данных (когда применимо). Например, для источника данных SQL на виртуальной машине Azure это поле будет содержать имя виртуальной машины, на которой существует База данных SQL | Строковый тип |
DatasourceSetResourceId | Идентификатор Azure Resource Manager (ARM) родительского ресурса источника данных (когда применимо). Например, для источника данных SQL на виртуальной машине Azure это поле будет содержать идентификатор Azure Resource Manager (ARM) виртуальной машины, на которой существует База данных SQL. | Строка |
DatasourceSetType | Тип родительского ресурса источника данных (когда применимо). Например, для источника данных SAP HANA на виртуальной машине Azure это поле будет иметь значение Microsoft.Compute/virtualMachines, так как родительский ресурс — виртуальная машина Azure | Строка |
PolicyName | Имя политики, связанной с экземпляром резервной копии | Строковый тип |
PolicyUniqueId | Внешний ключ, который ссылается на политику, связанную с экземпляром резервной копии | Строковый тип |
PolicyId | Идентификатор Azure Resource Manager (ARM) политики, связанной с экземпляром резервной копии | Строковый тип |
VaultResourceId | Идентификатор Azure Resource Manager (ARM) хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultUniqueId | Внешний ключ, который ссылается на хранилище, связанное с экземпляром резервной копии | Строковый тип |
Vaultname | Имя хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultTags | Теги хранилища, связанного с экземпляром резервной копии | Строка |
VaultSubscriptionId | Идентификатор подписки хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultLocation | Расположение хранилища, связанного с экземпляром резервной копии | Строковый тип |
VaultStore_StorageReplicationType | Тип репликации службы хранилища, связанного с экземпляром резервной копии | Строка |
VaultType | Тип хранилища, например Microsoft.RecoveryServices/vaults или Microsoft.DataProtection/backupVaults. | Строка |
TimeGenerated | Метка времени записи | Дата и время |
_AzureBackup_GetBillingGroupsTrends()
Эта функция возвращает записи журнала для каждой сущности выставления счетов, позволяя просматривать ключевые ежедневные, еженедельные и ежемесячные тенденции, связанные с размером интерфейсной части и использованием хранилища, с разной степенью детализации.
Параметры
Имя параметра | Описание | Обязательный? | Пример значения | Data type |
---|---|---|---|---|
RangeStart | Используйте этот параметр вместе с параметром RangeEnd для получения всех записей, относящихся к группе выставления счетов, за период времени с RangeStart по RangeEnd. | Да | "2021-03-03 00:00:00" | Дата и время |
RangeEnd | Используйте этот параметр вместе с параметром RangeStart для получения всех записей, относящихся к группе выставления счетов, за период времени с RangeStart по RangeEnd. | Да | "2021-03-10 00:00:00" | Дата и время |
VaultSubscriptionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора подписок, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую идентификаторы подписок, это позволит получить только те группы выставления счетов, которые находятся в указанных подписках. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех подписках. | Нет | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | Строка |
VaultLocationList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора регионов, где существуют резервные копии данных. Если в качестве параметра этой функции указать перечисленные через запятую регионы, это позволит получить только те группы выставления счетов, которые находятся в указанных регионах. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей во всех регионах. | Нет | eastus,westus |
Строка |
VaultList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора хранилищ. Если в качестве параметра этой функции указать перечисленные через запятую имена хранилищ, это позволит получить только те записи экземпляров резервной копии, которые относятся к указанным хранилищам. По умолчанию значение этого параметра равно "*", вследствие чего функция выполняет поиск записей групп выставления счетов во всех хранилищах. | Нет | vault1,vault2,vault3 |
Строка |
VaultTypeList | Используйте этот параметр, чтобы отфильтровать выходные данные функции по записям, относящимся к хранилищам конкретного типа. По умолчанию этот параметр имеет значение "*", поэтому функция выполняет поиск хранилищ служб восстановления и хранилищ резервных копий. | Нет | Microsoft.RecoveryServices/vaults | Строковый тип |
ExcludeLegacyEvent | Используйте этот параметр, чтобы выбрать, запрашивать ли данные в устаревшей таблице AzureDiagnostics или нет. Если значение этого параметра — false, функция запрашивает данные как из таблицы AzureDiagnostics, так и из таблиц для конкретных ресурсов. Если значение этого параметра — true, функция запрашивает данные только из таблиц для конкретных ресурсов. Значение по умолчанию — true. | Нет | Да | Логическое |
BackupSolutionList | Используйте этот параметр, чтобы отфильтровать выходные данные функции для определенного набора решений резервного копирования, используемых в среде Azure. Например, если указать Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM в качестве значения этого параметра, функция возвращает только записи, связанные с элементами, резервными копиями которых является резервное копирование виртуальной машины Azure, SQL в резервном копировании виртуальных машин Azure или DPM в Azure Backup. По умолчанию этот параметр имеет значение "*", что делает функцию возвращающей записи, относящиеся ко всем решениям резервного копирования, поддерживаемым отчетами о резервном копировании (поддерживаемые значения: "Azure Virtual Machine Backup", "SQL in Azure VM Backup", "SAP HANA in Azure VM Backup", "Azure Storage (Файлы Azure) Backup", "Azure Backup Agent", "DPM", "Azure Backup Server", " База данных Azure для PostgreSQL Резервное копирование сервера", "Резервное копирование BLOB-объектов Azure", "Резервное копирование дисков Azure" или сочетание любого из этих значений, разделенных запятыми). |
Нет | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
Строка |
BillingGroupName | Используйте этот параметр для поиска определенной группы выставления счетов. По умолчанию значение — "*", вследствие чего функция выполняет поиск всех групп выставления счетов. | Нет | testvm | Строка |
AggregationType | Используйте этот параметр, чтобы указать степень детализации времени, данные за которое необходимо получить. Если значение этого параметра — Daily, функция возвращает запись для каждой группы выставления счетов за каждый день, что позволяет анализировать ежедневные тенденции использования хранилища и размера интерфейсной части. Если значение этого параметра — Weekly, функция возвращает запись для каждого экземпляра резервной копии за каждую неделю, что позволяет анализировать еженедельные тенденции. Аналогичным образом можно указать Monthly для анализа ежемесячных тенденций. Значение по умолчанию — Daily. При просмотре данных за более длительные диапазоны времени рекомендуется использовать значение Weekly или Monthly для повышения производительности запроса и упрощения анализа тенденций. | Нет | Weekly | Строка |
Возвращаемые поля
Имя поля | Описание | Data type |
---|---|---|
UniqueId | Первичный ключ, обозначающий уникальный идентификатор группы выставления счетов | Строка |
FriendlyName | Понятное имя группы выставления счетов | Строка |
Имя | Имя группы выставления счетов. | Строка |
Тип | Тип группы выставления счетов. Например, ProtectedContainer или BackupItem | Строковый тип |
SourceSizeInMBs | Размер интерфейсной части группы выставления счетов в МБ | Double |
VaultStore_StorageConsumptionInMBs | Общий объем облачного хранилища, использованного группой выставления счетов на стандартном уровне хранилища | Double |
BackupSolution | Решение резервного копирования, с которым связана группа выставления счетов. Например, резервное копирование виртуальных машин Azure, резервное копирование SQL на виртуальной машине Azure и т. д. | Строковый тип |
VaultResourceId | Идентификатор Azure Resource Manager (ARM) хранилища, связанного с группой выставления счетов | Строковый тип |
VaultUniqueId | Внешний ключ, который ссылается на хранилище, связанное с группой выставления счетов | Строка |
Vaultname | Имя хранилища, связанного с группой выставления счетов | Строка |
VaultTags | Теги хранилища, связанного с группой выставления счетов | Строка |
VaultSubscriptionId | Идентификатор подписки хранилища, связанного с группой выставления счетов | Строка |
VaultLocation | Расположение хранилища, связанного с группой выставления счетов | Строка |
VaultStore_StorageReplicationType | Тип репликации службы хранилища, связанного с группой выставления счетов | Строка |
VaultType | Тип хранилища, например Microsoft.RecoveryServices/vaults или Microsoft.DataProtection/backupVaults. | Строка |
TimeGenerated | Метка времени записи | Дата и время |
ExtendedProperties | Дополнительные свойства группы выставления счетов | Динамический |
Примеры запросов
Ниже приведены примеры запросов, которые помогут приступить к работе с системными функциями.
Все задания резервного копирования виртуальной машины Azure, завершившиеся с ошибкой в заданный диапазон времени
_AzureBackup_GetJobs("2021-03-05", "2021-03-06") //call function with RangeStart and RangeEnd parameters set, and other parameters with default value | where BackupSolution=="Azure Virtual Machine Backup" and Status=="Failed" | project BackupInstanceFriendlyName, BackupInstanceId, OperationCategory, Status, JobStartDateTime=StartTime, JobDuration=DurationInSecs/3600, ErrorTitle, DataTransferred=DataTransferredInMBs
Все задания резервного копирования журналов SQL в заданный диапазон времени
_AzureBackup_GetJobs("2021-03-05", "2021-03-06","*","*","*","*",true,"*","*","*","*","*","*",false) //call function with RangeStart and RangeEnd parameters set, ExcludeLog parameter as false, and other parameters with default value | where BackupSolution=="SQL in Azure VM Backup" and Operation=="Log" | project BackupInstanceFriendlyName, BackupInstanceId, OperationCategory, Status, JobStartDateTime=StartTime, JobDuration=DurationInSecs/3600, ErrorTitle, DataTransferred=DataTransferredInMBs
Еженедельная тенденция использования хранилища резервных копий для виртуальной машины testvm
_AzureBackup_GetBackupInstancesTrends("2021-01-01", "2021-03-06","*","*","*","*",false,"*","*","*","*",true, "Weekly") //call function with RangeStart and RangeEnd parameters set, AggregationType parameter as Weekly, and other parameters with default value | where BackupSolution == "Azure Virtual Machine Backup" | where FriendlyName == "testvm" | project TimeGenerated, VaultStore_StorageConsumptionInMBs | render timechart