Funções do sistema para Backup do Azure
Este artigo descreve como gravar consultas personalizadas nos Logs do Azure Monitor usando funções do sistema.
O Backup do Azure fornece um conjunto de funções, chamadas de funções do sistema ou funções da solução, que estão disponíveis por padrão nos workspaces do LA (Log Analytics).
Essas funções operam em dados nas tabelas brutas do Backup do Azure no LA e retornam dados formatados que ajudam a recuperar facilmente as informações de todas as entidades relacionadas ao backup, usando consultas simples. Os usuários podem passar parâmetros para essas funções para filtrar os dados retornados por essas funções.
É recomendável usar as funções do sistema para consultar os dados de backup no workspace do LA para criar relatórios personalizados, pois fornecem vários benefícios, conforme detalhado na seção abaixo.
Benefícios do uso das funções do sistema
Consultas mais simples: o uso das funções ajuda a reduzir o número de junções necessárias nas consultas. Por padrão, as funções retornam esquemas ‘mesclados’, que incorporam todas as informações relativas à entidade (instância de backup, trabalho, cofre e assim por diante) que estão sendo consultadas. Por exemplo, se você precisar obter uma lista de trabalhos de backup bem-sucedidos por nome de item de backup e o contêiner associado, uma chamada simples para a função _AzureBackup_getJobs() fornecerá todas essas informações para cada trabalho. Por outro lado, consultar as tabelas brutas diretamente exigiria que você executasse várias junções entre as tabelas AddonAzureBackupJobs e CoreAzureBackup.
Transição mais suave do evento de diagnóstico herdado: usar as funções do sistema ajuda a fazer uma transição suave do evento de diagnóstico herdado (AzureBackupReport no modo AzureDiagnostics) para os eventos específicos do recurso. Todas as funções do sistema fornecidas pelo Backup do Azure possibilitam que você especifique um parâmetro que permite escolher se a função deve consultar dados somente das tabelas específicas do recurso ou consultar dados da tabela herdada e das tabelas específicas do recurso (com eliminação de duplicação de registros).
- Se você migrou com êxito para as tabelas específicas do recurso, pode impedir a tabela herdada sejam consultada pela da função.
- Caso esteja no processo de migração no momento e tenha alguns dados nas tabelas herdadas que são necessários para análise, você poderá incluir a tabela herdada. Quando a transição for concluída e você não precisar mais dos dados da tabela herdada, atualize o valor do parâmetro passado para a função nas consultas, para excluir a tabela herdada.
- Caso ainda esteja usando apenas a tabela herdada, as funções continuarão a funcionar se você incluir a tabela herdada usando o mesmo parâmetro. No entanto, é recomendável mudar para as tabelas específicas do recurso no início.
Reduz a possibilidade de interrupção das consultas personalizadas: se o Backup do Azure apresentar melhorias no esquema das tabelas do LA subjacentes para aceitar futuros cenários de relatório, a definição das funções também será atualizada para levar em conta as alterações do esquema. Portanto, caso use as funções do sistema para criar consultas personalizadas, as consultas não serão interrompidas, mesmo se houver alterações no esquema subjacente das tabelas.
Observação
As funções do sistema são mantidas pela Microsoft e as definições não podem ser editadas pelos usuários. Se você precisar de funções editáveis, pode criar funções salvas no LA.
Tipos de funções do sistema oferecidas pelo Backup do Azure
Funções principais: são funções que ajudam a consultar qualquer uma das principais entidades do Backup do Azure, como instâncias de backup, cofres, políticas, trabalhos e entidades de cobrança. Por exemplo, a função _AzureBackup_getBackupInstances retorna uma lista de todas as instâncias de backup existentes no ambiente a partir do último dia completo (em UTC). Os parâmetros e o esquema retornado para cada uma dessas funções principais são resumidos abaixo neste artigo.
Funções de tendência: são funções que retornam registros históricos para as entidades relacionadas ao backup (por exemplo, instâncias de backup, grupos de cobrança) e permitem obter informações de tendências diárias, semanais e mensais sobre as principais métricas (por exemplo, contagem, armazenamento consumido) relativas a essas entidades. Os parâmetros e o esquema retornado para cada uma dessas funções de tendência são resumidos abaixo neste artigo.
Observação
Atualmente, as funções do sistema retornam dados até o último dia completo (em UTC). Os dados para o dia parcial atual não são retornados. Portanto, se você deseja recuperar os registros do dia atual, precisará usar as tabelas brutas do LA.
Lista de funções do sistema
Core Functions
_AzureBackup_GetVaults()
Esta função retorna a lista de todos os cofres dos Serviços de Recuperação no ambiente do Azure que estão associados ao workspace do LA.
Parâmetros
| Nome do parâmetro | Descrição | Obrigatório? | Valor de exemplo | Data type |
|---|---|---|---|---|
| RangeStart | Use este parâmetro juntamente com o parâmetro RangeEnd somente se precisar buscar todos os registros relacionados ao cofre no período entre RangeStart e RangeEnd. Por padrão, o valor de RangeStart e RangeEnd é nulo, o que fará com que a função recupere somente o registro mais recente de cada cofre. | N | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | Use este parâmetro juntamente com o parâmetro RangeStart somente se precisar buscar todos os registros relacionados ao cofre no período entre RangeStart e RangeEnd. Por padrão, o valor de RangeStart e RangeEnd é nulo, o que fará com que a função recupere somente o registro mais recente de cada cofre. | N | "2021-03-10 00:00:00" | DateTime |
| VaultSubscriptionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de assinaturas em que existem dados de backup. Especificar uma lista separada por vírgula de IDs de assinatura como parâmetro para essa função ajuda a recuperar somente os cofres que estão nas assinaturas especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as assinaturas. | N | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | Use este parâmetro para filtrar a saída da função para determinado conjunto de regiões em que existem dados de backup. Especificar uma lista separada por vírgula de regiões como parâmetro para essa função ajuda a recuperar somente os cofres que estão nas regiões especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as regiões. | N | eastus,westus |
String |
| VaultList | Use este parâmetro para filtrar a saída da função para determinado conjunto de cofres. Especificar uma lista separada por vírgula de nomes de cofre como parâmetro para essa função ajuda a recuperar somente os registros relativos aos cofres especificados. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todos cofres. | N | vault1,vault2,vault3 |
String |
| VaultTypeList | Use este parâmetro para filtrar a saída da função para os registros relativos a um tipo de cofre específico. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise cofres dos Serviços de Recuperação e cofres de Backup. | N | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | Use este parâmetro para escolher se deseja consultar dados na tabela herdada AzureDiagnostics. Se o valor desse parâmetro for false, a função consultará os dados da tabela AzureDiagnostics e das tabelas específicas do recurso. Se o valor desse parâmetro for true, a função consultará somente os dados das tabelas específicas do recurso. O valor padrão é true. | N | true | Boolean |
Campos retornados
| Nome do Campo | Descrição | Data type |
|---|---|---|
| UniqueId | Chave primária que indica a ID exclusiva do cofre | String |
| ID | ID do cofre no ARM (Azure Resource Manager) | String |
| Nome | Nome do cofre | String |
| SubscriptionId | ID da assinatura em que existe o cofre | String |
| Local | Local em que existe o cofre | String |
| VaultStore_StorageReplicationType | Tipo de replicação de armazenamento associado ao cofre | String |
| Marcações | Marcações do cofre | String |
| TimeGenerated | Carimbo de data/hora do registro | DateTime |
| Type | Tipo do cofre, por exemplo, "Microsoft.RecoveryServices/vaults" ou "Microsoft.DataProtection/backupVaults" | String |
_AzureBackup_GetPolicies()
Esta função retorna a lista de políticas de backup usadas no ambiente do Azure, juntamente com as informações detalhadas sobre cada política, como o tipo de fonte de dados, o tipo de replicação de armazenamento e assim por diante.
Parâmetros
| Nome do parâmetro | Descrição | Obrigatório? | Valor de exemplo | Data type |
|---|---|---|---|---|
| RangeStart | Use este parâmetro juntamente com o parâmetro RangeStart somente se precisar buscar todos os registros relacionados à política no período entre RangeStart e RangeEnd. Por padrão, o valor de RangeStart e RangeEnd é nulo, o que fará com que a função recupere somente o registro mais recente de cada política. | N | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | Use este parâmetro juntamente com o parâmetro RangeStart somente se precisar buscar todos os registros relacionados à política no período entre RangeStart e RangeEnd. Por padrão, o valor de RangeStart e RangeEnd é nulo, o que fará com que a função recupere somente o registro mais recente de cada política. | N | "2021-03-10 00:00:00" | DateTime |
| VaultSubscriptionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de assinaturas em que existem dados de backup. Especificar uma lista separada por vírgula de IDs de assinatura como parâmetro para essa função ajuda a recuperar somente as políticas que estão nas assinaturas especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as assinaturas. | N | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | Use este parâmetro para filtrar a saída da função para determinado conjunto de regiões em que existem dados de backup. Especificar uma lista separada por vírgula de regiões como parâmetro para essa função ajuda a recuperar somente as políticas que estão nas regiões especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as regiões. | N | eastus,westus |
String |
| VaultList | Use este parâmetro para filtrar a saída da função para determinado conjunto de cofres. Especificar uma lista separada por vírgula de nomes de cofre como parâmetro para essa função ajuda a recuperar somente os registros de políticas relativas aos cofres especificados. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros de políticas em todos cofres. | N | vault1,vault2,vault3 |
String |
| VaultTypeList | Use este parâmetro para filtrar a saída da função para os registros relativos a um tipo de cofre específico. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise cofres dos Serviços de Recuperação e cofres de Backup. | N | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | Use este parâmetro para escolher se deseja consultar dados na tabela herdada AzureDiagnostics. Se o valor desse parâmetro for false, a função consultará os dados da tabela AzureDiagnostics e das tabelas específicas do recurso. Se o valor desse parâmetro for true, a função consultará somente os dados das tabelas específicas do recurso. O valor padrão é true. | N | true | Boolean |
| BackupSolutionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de soluções de backup usadas no ambiente do Azure. Por exemplo, se você especificar Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM como o valor desse parâmetro, a função retornará somente os registros relacionados aos itens de backup que usam backup de Máquina Virtual do Azure, SQL no backup de VM do Azure ou DPM para o backup do Azure. Por padrão, o valor desse parâmetro é '*', o que faz com que a função retorne os registros relativos a todas as soluções de backup com suporte nos Relatórios de Backup (os valores com suporte são "Backup de Máquina Virtual do Azure", "SQL no Backup de VM do Azure", "SAP HANA no Backup de VM do Azure", "Backup de Armazenamento do Azure (Arquivos do Azure)", "Agente de Backup do Azure", "DPM", "Servidor de Backup do Azure", Banco de Dados PostgreSQL do Azure, Backup de Blob do Azure, Backup de Disco do Azure ou uma combinação separada por vírgula de qualquer um desses valores). |
N | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
Campos retornados
| Nome do Campo | Descrição | **Data type ** |
|---|---|---|
| UniqueId | Chave primária que indica a ID exclusiva da política | String |
| ID | ID da política no ARM (Azure Resource Manager) | String |
| Nome | Nome da política | String |
| TimeZone | Fuso horário no qual a política é definida | String |
| Solução de Backup | Solução de Backup à qual a política está associada. Por exemplo, Backup de VM do Azure, SQL no Backup de VM do Azure e assim por diante. | String |
| TimeGenerated | Carimbo de data/hora do registro | Datetime |
| VaultUniqueId | Chave estrangeira que se refere ao cofre associado à política | String |
| VaultResourceId | ID do cofre associado à política no ARM (Azure Resource Manager) | String |
| VaultName | Nome do cofre associado à política | String |
| VaultTags | Marcações do cofre associado à política | String |
| VaultLocation | Local do cofre associado à política | String |
| VaultSubscriptionId | ID de assinatura do cofre associado à política | String |
| VaultStore_StorageReplicationType | Tipo de Replicação de Armazenamento do cofre associado à política | String |
| VaultType | Tipo do cofre, por exemplo, "Microsoft.RecoveryServices/vaults" ou "Microsoft.DataProtection/backupVaults" | String |
| ExtendedProperties | Propriedades adicionais da política | Dinâmico |
_AzureBackup_GetJobs()
Esta função retorna uma lista de todos os trabalhos relacionados a backup e restauração que foram disparados em um intervalo de tempo especificado, juntamente com as informações detalhadas sobre cada trabalho, como status do trabalho, duração do trabalho, dados transferidos e assim por diante.
Parâmetros
| Nome do parâmetro | Descrição | Obrigatório? | Valor de exemplo | **Data type ** |
|---|---|---|---|---|
| RangeStart | Use este parâmetro juntamente com o parâmetro RangeEnd para recuperar a lista de todos os trabalhos que foram iniciados no período entre RangeStart e RangeEnd. | S | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | Use este parâmetro juntamente com o parâmetro RangeStart para recuperar a lista de todos os trabalhos que foram iniciados no período entre RangeStart e RangeEnd. | S | "2021-03-10 00:00:00" | DateTime |
| VaultSubscriptionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de assinaturas em que existem dados de backup. Especificar uma lista separada por vírgula de IDs de assinatura como parâmetro para essa função ajuda a recuperar somente os trabalhos que estão associados aos cofres nas assinaturas especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as assinaturas. | N | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | Use este parâmetro para filtrar a saída da função para determinado conjunto de regiões em que existem dados de backup. Especificar uma lista separada por vírgula de regiões como parâmetro para essa função ajuda a recuperar somente os trabalhos que estão associados aos cofres nas regiões especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as regiões. | N | eastus,westus |
String |
| VaultList | Use este parâmetro para filtrar a saída da função para determinado conjunto de cofres. Especificar uma lista separada por vírgula de nomes de cofre como parâmetro para essa função ajuda a recuperar somente os trabalhos relativos aos cofres especificados. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise trabalhos em todos cofres. | N | vault1,vault2,vault3 |
String |
| VaultTypeList | Use este parâmetro para filtrar a saída da função para os registros relativos a um tipo de cofre específico. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise cofres dos Serviços de Recuperação e cofres de Backup. | N | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | Use este parâmetro para escolher se deseja consultar dados na tabela herdada AzureDiagnostics. Se o valor desse parâmetro for false, a função consultará os dados da tabela AzureDiagnostics e das tabelas específicas do recurso. Se o valor desse parâmetro for true, a função consultará somente os dados das tabelas específicas do recurso. O valor padrão é true. | N | true | Boolean |
| BackupSolutionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de soluções de backup usadas no ambiente do Azure. Por exemplo, se você especificar Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM como o valor desse parâmetro, a função retornará somente os registros relacionados aos itens de backup que usam backup de Máquina Virtual do Azure, SQL no backup de VM do Azure ou DPM para o backup do Azure. Por padrão, o valor desse parâmetro é '*', o que faz com que a função retorne os registros relativos a todas as soluções de backup com suporte nos Relatórios de Backup (os valores com suporte são "Backup de Máquina Virtual do Azure", "SQL no Backup de VM do Azure", "SAP HANA no Backup de VM do Azure", "Backup de Armazenamento do Azure (Arquivos do Azure)", "Agente de Backup do Azure", "DPM", "Servidor de Backup do Azure", Banco de Dados PostgreSQL do Azure, Backup de Blob do Azure, Backup de Disco do Azure ou uma combinação separada por vírgula de qualquer um desses valores). |
N | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| JobOperationList | Use este parâmetro para filtrar a saída da função para um tipo de trabalho específico. Por exemplo, as operações de backup ou restauração. Por padrão, o valor desse parâmetro é "*", o que faz com que a função pesquise trabalhos de Backup e Restauração. | N | "Backup" | String |
| JobStatusList | Use este parâmetro para filtrar a saída da função para um status de trabalho específico. Por exemplo, Concluído, Falha e assim por diante. Por padrão, o valor desse parâmetro é "*", o que faz com que a função pesquise todos os trabalhos, independentemente do status. | N | Failed,CompletedWithWarnings |
String |
| JobFailureCodeList | Use este parâmetro para filtrar a saída da função para um código de falha específico. Por padrão, o valor desse parâmetro é "*", o que faz com que a função pesquise todos os trabalhos, independentemente do código de falha. | N | "Success" | String |
| DatasourceSetName | Use este parâmetro para filtrar a saída da função para um recurso pai específico. Por exemplo, para retornar o SQL nas instâncias de backup de VM do Azure que pertencem à máquina virtual "testvm", especifique testvm como o valor desse parâmetro. Por padrão, o valor é "*", o que faz com que a função pesquise registros em todas as instâncias de backup. | N | "testvm" | String |
| BackupInstanceName | Use este parâmetro para pesquisar trabalhos em uma instância de backup específica por nome. Por padrão, o valor é "*", o que faz com que a função pesquise registros em todas as instâncias de backup. | N | "testvm" | String |
| ExcludeLog | Use este parâmetro para impedir que os trabalhos de log sejam retornados pela função (ajuda no desempenho da consulta). Por padrão, o valor desse parâmetro é true, o que faz com que a função exclua os trabalhos de log. | N | true | Boolean |
Campos retornados
| Nome do Campo | Descrição | **Data type ** |
|---|---|---|
| UniqueId | Chave primária que indica a ID exclusiva do trabalho | String |
| OperationCategory | Categoria da operação que está sendo realizada. Por exemplo, Backup, Restauração | String |
| Operação | Detalhes da operação que está sendo realizada. Por exemplo, Log (para backup de log) | String |
| Status | Status do trabalho. Por exemplo, Concluído, Falha, CompletedWithWarnings | String |
| ErrorTitle | Código de falha do trabalho | Cadeia de caracteres |
| StartTime | Data e hora de início do trabalho | DateTime |
| DurationInSecs | Duração do trabalho em segundos | Double |
| DataTransferredInMBs | Dados transferidos pelo trabalho em MBs Atualmente, esse campo só tem suporte para cargas de trabalho do cofre dos Serviços de Recuperação | Double |
| RestoreJobRPDateTime | A data e a hora em que o ponto de recuperação que está sendo recuperado foi criado Atualmente, esse campo só tem suporte para cargas de trabalho do cofre dos Serviços de Recuperação | Datetime |
| RestoreJobRPLocation | O local em que o ponto de recuperação que está sendo recuperado foi armazenado | String |
| BackupInstanceUniqueId | Chave estrangeira que se refere à instância de backup associada ao trabalho | String |
| BackupInstanceId | ID da instância de backup associada ao trabalho no ARM (Azure Resource Manager) | String |
| BackupInstanceFriendlyName | Nome da instância de backup associada ao trabalho | String |
| DatasourceResourceId | ID da fonte de base subjacente associada ao trabalho no ARM (Azure Resource Manager). Por exemplo, ID da VM no ARM (Azure Resource Manager) | String |
| DatasourceFriendlyName | Nome amigável da fonte de base subjacente associada ao trabalho | String |
| DatasourceType | Tipo da fonte de dados associada ao trabalho. Por exemplo, "Microsoft.Compute/virtualMachines" | String |
| BackupSolution | Solução de Backup à qual o trabalho está associado. Por exemplo, Backup de VM do Azure, SQL no Backup de VM do Azure e assim por diante. | String |
| DatasourceSetResourceId | ID do recurso pai da fonte de dados no ARM (Azure Resource Manager) (sempre que aplicável). Por exemplo, para um SQL na fonte de dados da VM do Azure, esse campo conterá a ID da VM no ARM (Azure Resource Manager), na qual existe o banco de dados SQL | String |
| DatasourceSetType | Tipo do recurso pai da fonte de dados (sempre que aplicável). Por exemplo, para um SAP HANA na fonte de dados da VM do Azure, esse campo será Microsoft.Compute/virtualMachines, pois o recurso pai é uma VM do Azure | String |
| VaultResourceId | ID do cofre associado ao trabalho no ARM (Azure Resource Manager) | String |
| VaultUniqueId | Chave estrangeira que se refere ao cofre associado ao trabalho | String |
| VaultName | Name do cofre associado ao trabalho | String |
| VaultTags | Marcações do cofre associado ao trabalho | String |
| VaultSubscriptionId | ID de assinatura do cofre associado ao trabalho | String |
| VaultLocation | Local do cofre associado ao trabalho | String |
| VaultStore_StorageReplicationType | Tipo de Replicação de Armazenamento do cofre associado ao trabalho | String |
| VaultType | Tipo do cofre, por exemplo, "Microsoft.RecoveryServices/vaults" ou "Microsoft.DataProtection/backupVaults" | String |
| TimeGenerated | Carimbo de data/hora do registro | DateTime |
_AzureBackup_GetBackupInstances()
Essa função retorna a lista de instâncias de backup associadas aos cofres dos Serviços de Recuperação, juntamente com as informações detalhadas sobre cada instância de backup, como consumo de armazenamento em nuvem, política associada e assim por diante.
Parâmetros
| Nome do parâmetro | Descrição | Obrigatório? | Valor de exemplo | **Data type ** |
|---|---|---|---|---|
| RangeStart | Use este parâmetro juntamente com o parâmetro RangeEnd somente se precisar buscar todos os registros relacionados à instância de backup no período entre RangeStart e RangeEnd. Por padrão, o valor de RangeStart e RangeEnd é nulo, o que fará com que a função recupere somente o registro mais recente de cada instância de backup. | N | "2021-03-03 00:00:00" | DataTime |
| RangeEnd | Use este parâmetro juntamente com o parâmetro RangeStart somente se precisar buscar todos os registros relacionados à instância de backup no período entre RangeStart e RangeEnd. Por padrão, o valor de RangeStart e RangeEnd é nulo, o que fará com que a função recupere somente o registro mais recente de cada instância de backup. | N | "2021-03-10 00:00:00" | DateTime |
| VaultSubscriptionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de assinaturas em que existem dados de backup. Especificar uma lista separada por vírgula de IDs de assinatura como parâmetro para essa função ajuda a recuperar somente as instâncias de backup que estão nas assinaturas especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as assinaturas. | N | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | Use este parâmetro para filtrar a saída da função para determinado conjunto de regiões em que existem dados de backup. Especificar uma lista separada por vírgula de regiões como parâmetro para essa função ajuda a recuperar somente as instâncias de backup que estão nas regiões especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as regiões. | N | eastus,westus |
String |
| VaultList | Use este parâmetro para filtrar a saída da função para determinado conjunto de cofres. Especificar uma lista separada por vírgula de nomes de cofre como parâmetro para essa função ajuda a recuperar somente os registros de instâncias de backup relativas aos cofres especificados. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros de instâncias de backup em todos cofres. | N | vault1,vault2,vault3 |
String |
| VaultTypeList | Use este parâmetro para filtrar a saída da função para os registros relativos a um tipo de cofre específico. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise cofres dos Serviços de Recuperação e cofres de Backup. | N | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | Use este parâmetro para escolher se deseja consultar dados na tabela herdada AzureDiagnostics. Se o valor desse parâmetro for false, a função consultará os dados da tabela AzureDiagnostics e das tabelas específicas do recurso. Se o valor desse parâmetro for true, a função consultará somente os dados das tabelas específicas do recurso. O valor padrão é true. | N | true | Boolean |
| BackupSolutionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de soluções de backup usadas no ambiente do Azure. Por exemplo, se você especificar Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM como o valor desse parâmetro, a função retornará somente os registros relacionados aos itens de backup que usam backup de Máquina Virtual do Azure, SQL no backup de VM do Azure ou DPM para o backup do Azure. Por padrão, o valor desse parâmetro é '*', o que faz com que a função retorne os registros relativos a todas as soluções de backup com suporte nos Relatórios de Backup (os valores com suporte são "Backup de Máquina Virtual do Azure", "SQL no Backup de VM do Azure", "SAP HANA no Backup de VM do Azure", "Backup de Armazenamento do Azure (Arquivos do Azure)", "Agente de Backup do Azure", "DPM", "Servidor de Backup do Azure", Banco de Dados PostgreSQL do Azure, Backup de Blob do Azure, Backup de Disco do Azure ou uma combinação separada por vírgula de qualquer um desses valores). |
N | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| ProtectionInfoList | Use este parâmetro para escolher se deseja incluir somente as instâncias de backup que estão ativamente protegidas ou também as instâncias com a proteção interrompida e as instâncias com o backup inicial está pendente. Para cargas de trabalho do cofre dos serviços de recuperação, os valores com suporte são "Protected", "ProtectionStopped", "InitialBackupPending" ou uma combinação separada por vírgula de qualquer um desses valores. Para cargas de trabalho do cofre de backup, os valores com suporte são "Protected", "ConfiguringProtection", "ConfiguringProtectionFailed", "UpdatingProtection", "ProtectionError", "ProtectionStopped" ou uma combinação separada por vírgulas de qualquer um desses valores. Por padrão, o valor é "*", o que faz com que a função pesquise todas as instâncias de backup, independentemente dos detalhes da proteção. | N | "Protected" | String |
| DatasourceSetName | Use este parâmetro para filtrar a saída da função para um recurso pai específico. Por exemplo, para retornar o SQL nas instâncias de backup de VM do Azure que pertencem à máquina virtual "testvm", especifique testvm como o valor desse parâmetro. Por padrão, o valor é "*", o que faz com que a função pesquise registros em todas as instâncias de backup. | N | "testvm" | String |
| BackupInstanceName | Use este parâmetro para pesquisar uma instância de backup específica por nome. Por padrão, o valor é "*", o que faz com que a função pesquise todas as instâncias de backup. | N | "testvm" | String |
| DisplayAllFields | Use este parâmetro para escolher se deseja recuperar apenas um subconjunto dos campos retornados pela função. Se o valor desse parâmetro for false, a função eliminará as informações relacionadas ao armazenamento e ao ponto de retenção da saída da função. Isto será útil caso esteja usando essa função como etapa intermediária em uma consulta maior e precisar otimizar o desempenho da consulta, eliminando as colunas que você não precisa para análise. Por padrão, o valor desse parâmetro é true, o que faz com que a função retorne todos os campos relativos à instância de backup. | N | true | Boolean |
Campos retornados
| Nome do Campo | Descrição | Data type |
|---|---|---|
| UniqueId | Chave primária que indica a ID exclusiva da instância de backup | String |
| ID | ID da instância de backup no ARM (Azure Resource Manager) | String |
| FriendlyName | Nome amigável da instância de backup | String |
| ProtectionInfo | Informações sobre as configurações de proteção da instância de backup. Por exemplo, a proteção está configurada, proteção interrompida, backup inicial pendente | String |
| LatestRecoveryPoint | Data e hora do ponto de recuperação mais recente associado à instância de backup. Atualmente, esse campo só tem suporte para cargas de trabalho do cofre dos Serviços de Recuperação. | DateTime |
| OldestRecoveryPoint | Data e hora do ponto de recuperação mais antigo associado à instância de backup Atualmente, esse campo só tem suporte para cargas de trabalho do cofre dos Serviços de Recuperação. | DateTime |
| SourceSizeInMBs | Tamanho de front-end da instância de backup em MBs | Double |
| VaultStore_StorageConsumptionInMBs | Total de armazenamento em nuvem consumido pela instância de backup na camada standard do cofre | Double |
| DataSourceFriendlyName | Nome amigável da fonte de dados correspondente à instância de backup | String |
| BackupSolution | Solução de Backup à qual a instância de backup está associada. Por exemplo, Backup de VM do Azure, SQL no Backup de VM do Azure e assim por diante. | String |
| DatasourceType | Tipo da fonte de dados correspondente à instância de backup. Por exemplo, "Microsoft.Compute/virtualMachines" | String |
| DatasourceResourceId | ID da fonte de dados subjacente no ARM (Azure Resource Manager) correspondente à instância de backup. Por exemplo, ID da VM no ARM (Azure Resource Manager) | String |
| DatasourceSetFriendlyName | Nome amigável do recurso pai da fonte de dados (sempre que aplicável). Por exemplo, para um SQL na fonte de dados da VM do Azure, esse campo conterá o nome da VM em que existe o banco de dados SQL | String |
| DatasourceSetFriendlyName | Nome amigável do recurso pai da fonte de dados (sempre que aplicável). Por exemplo, para um SQL na fonte de dados da VM do Azure, esse campo conterá o nome da VM em que existe o banco de dados SQL | String |
| DatasourceSetResourceId | ID do recurso pai da fonte de dados no ARM (Azure Resource Manager) (sempre que aplicável). Por exemplo, para um SQL na fonte de dados da VM do Azure, esse campo conterá a ID da VM no ARM (Azure Resource Manager), na qual existe o banco de dados SQL | String |
| DatasourceSetType | Tipo do recurso pai da fonte de dados (sempre que aplicável). Por exemplo, para um SAP HANA na fonte de dados da VM do Azure, esse campo será Microsoft.Compute/virtualMachines, pois o recurso pai é uma VM do Azure | String |
| PolicyName | Nome da política associada à instância de backup | String |
| PolicyUniqueId | Chave estrangeira que se refere à política associada à instância de backup | String |
| PolicyId | ID da política associada à instância de backup no ARM (Azure Resource Manager) | String |
| VaultResourceId | ID do cofre associado à instância de backup no ARM (Azure Resource Manager) | String |
| VaultUniqueId | Chave estrangeira que se refere ao cofre associado à instância de backup | String |
| VaultName | Nome do cofre associado à instância de backup | String |
| VaultTags | Marcações do cofre associado à instância de backup | String |
| VaultSubscriptionId | ID de assinatura do cofre associado à instância de backup | String |
| VaultLocation | Local do cofre associado à instância de backup | String |
| VaultStore_StorageReplicationType | Tipo de Replicação de Armazenamento do cofre associado à instância de backup | String |
| VaultType | Tipo do cofre, que é, "Microsoft.RecoveryServices/vaults" ou "Microsoft.DataProtection/backupVaults" | String |
| TimeGenerated | Carimbo de data/hora do registro | Datetime |
_AzureBackup_GetBillingGroups()
Esta função retorna uma lista de todas as entidades de cobrança relacionadas ao backup (grupos de cobrança), juntamente com as informações sobre os principais componentes de cobrança, como tamanho de front-end e total de armazenamento em nuvem.
Parâmetros
| Nome do parâmetro | Descrição | Obrigatório? | Valor de exemplo | Tipo de data |
|---|---|---|---|---|
| RangeStart | Use este parâmetro juntamente com o parâmetro RangeEnd somente se precisar buscar todos os registros relacionados ao grupo de cobrança no período entre RangeStart e RangeEnd. Por padrão, o valor de RangeStart e RangeEnd é nulo, o que fará com que a função recupere somente o registro mais recente de cada grupo de cobrança. | N | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | Use este parâmetro juntamente com o parâmetro RangeStart somente se precisar buscar todos os registros relacionados ao grupo de cobrança no período entre RangeStart e RangeEnd. Por padrão, o valor de RangeStart e RangeEnd é nulo, o que fará com que a função recupere somente o registro mais recente de cada grupo de cobrança. | N | "2021-03-10 00:00:00" | DateTime |
| VaultSubscriptionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de assinaturas em que existem dados de backup. Especificar uma lista separada por vírgula de IDs de assinatura como parâmetro para essa função ajuda a recuperar somente os grupos de cobrança que estão nas assinaturas especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as assinaturas. | N | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | Use este parâmetro para filtrar a saída da função para determinado conjunto de regiões em que existem dados de backup. Especificar uma lista separada por vírgula de regiões como parâmetro para essa função ajuda a recuperar somente os grupos de cobrança que estão nas regiões especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as regiões. | N | eastus,westus |
String |
| VaultList | Use este parâmetro para filtrar a saída da função para determinado conjunto de cofres. Especificar uma lista separada por vírgula de nomes de cofre como parâmetro para essa função ajuda a recuperar somente os registros de instâncias de backup relativas aos cofres especificados. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros de grupos de cobrança em todos cofres. | N | vault1,vault2,vault3 |
String |
| VaultTypeList | Use este parâmetro para filtrar a saída da função para os registros relativos a um tipo de cofre específico. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise cofres dos Serviços de Recuperação e cofres de Backup. | N | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | Use este parâmetro para escolher se deseja consultar dados na tabela herdada AzureDiagnostics. Se o valor desse parâmetro for false, a função consultará os dados da tabela AzureDiagnostics e das tabelas específicas do recurso. Se o valor desse parâmetro for true, a função consultará somente os dados das tabelas específicas do recurso. O valor padrão é true. | N | true | Boolean |
| BackupSolutionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de soluções de backup usadas no ambiente do Azure. Por exemplo, se você especificar Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM como o valor desse parâmetro, a função retornará somente os registros relacionados aos itens de backup que usam backup de Máquina Virtual do Azure, SQL no backup de VM do Azure ou DPM para o backup do Azure. Por padrão, o valor desse parâmetro é '*', o que faz com que a função retorne os registros relativos a todas as soluções de backup com suporte nos Relatórios de Backup (os valores com suporte são "Backup de Máquina Virtual do Azure", "SQL no Backup de VM do Azure", "SAP HANA no Backup de VM do Azure", "Backup de Armazenamento do Azure (Arquivos do Azure)", "Agente de Backup do Azure", "DPM", "Servidor de Backup do Azure", Banco de Dados PostgreSQL do Azure, Backup de Blob do Azure, Backup de Disco do Azure ou uma combinação separada por vírgula de qualquer um desses valores). |
N | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| BillingGroupName | Use este parâmetro para pesquisar um grupo de cobrança específico por nome. Por padrão, o valor é "*", o que faz com que a função pesquise todos os grupos de cobrança. | N | "testvm" | String |
Campos retornados
| Nome do Campo | Descrição | Data type |
|---|---|---|
| UniqueId | Chave primária que indica a ID exclusiva do grupo de cobrança | String |
| FriendlyName | Nome amigável do grupo de cobrança | String |
| Nome | Nome do grupo de cobrança | String |
| Type | Tipo do grupo de cobrança. Por exemplo, ProtectedContainer ou BackupItem | String |
| SourceSizeInMBs | Tamanho de front-end do grupo de cobrança em MBs | Double |
| VaultStore_StorageConsumptionInMBs | Total de armazenamento em nuvem consumido pelo grupo de cobrança na camada standard do cofre | Double |
| BackupSolution | Solução de Backup à qual o grupo de cobrança está associado. Por exemplo, Backup de VM do Azure, SQL no Backup de VM do Azure e assim por diante. | String |
| VaultResourceId | ID do cofre associado ao grupo de cobrança no ARM (Azure Resource Manager) | String |
| VaultUniqueId | Chave estrangeira que se refere ao cofre associado ao grupo de cobrança | String |
| VaultName | Nome do cofre associado ao grupo de cobrança | String |
| VaultTags | Marcações do cofre associado ao grupo de cobrança | String |
| VaultSubscriptionId | ID de assinatura do cofre associado ao grupo de cobrança | String |
| VaultLocation | Local do cofre associado ao grupo de cobrança | String |
| VaultStore_StorageReplicationType | Tipo de Replicação de Armazenamento do cofre associado ao grupo de cobrança | String |
| VaultType | Tipo do cofre, por exemplo, "Microsoft.RecoveryServices/vaults" ou "Microsoft.DataProtection/backupVaults" | String |
| TimeGenerated | Carimbo de data/hora do registro | DateTime |
| ExtendedProperties | Propriedades adicionais do grupo de cobrança | Dinâmico |
Funções de tendência
_AzureBackup_GetBackupInstancesTrends()
Esta função retorna os registros históricos de cada instância de backup, permitindo exibir as principais tendências diárias, semanais e mensais relacionadas à contagem de instâncias de backup e ao consumo de armazenamento, em vários níveis de granularidade.
Parâmetros
| Nome do parâmetro | Descrição | Obrigatório? | Valor de exemplo | Data type |
|---|---|---|---|---|
| RangeStart | Use este parâmetro juntamente com o parâmetro RangeEnd para recuperar todos os registros relacionados à instância de backup no período entre RangeStart e RangeEnd. | S | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | Use este parâmetro juntamente com o parâmetro RangeStart para recuperar todos os registros relacionados à instância de backup no período entre RangeStart e RangeEnd. | S | "2021-03-10 00:00:00" | DateTime |
| VaultSubscriptionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de assinaturas em que existem dados de backup. Especificar uma lista separada por vírgula de IDs de assinatura como parâmetro para essa função ajuda a recuperar somente as instâncias de backup que estão nas assinaturas especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as assinaturas. | N | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | Use este parâmetro para filtrar a saída da função para determinado conjunto de regiões em que existem dados de backup. Especificar uma lista separada por vírgula de regiões como parâmetro para essa função ajuda a recuperar somente as instâncias de backup que estão nas regiões especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as regiões. | N | eastus,westus |
String |
| VaultList | Use este parâmetro para filtrar a saída da função para determinado conjunto de cofres. Especificar uma lista separada por vírgula de nomes de cofre como parâmetro para essa função ajuda a recuperar somente os registros de instâncias de backup relativas aos cofres especificados. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros de instâncias de backup em todos cofres. | N | vault1,vault2,vault3 |
String |
| VaultTypeList | Use este parâmetro para filtrar a saída da função para os registros relativos a um tipo de cofre específico. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise cofres dos Serviços de Recuperação e cofres de Backup. | N | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | Use este parâmetro para escolher se deseja consultar dados na tabela herdada AzureDiagnostics. Se o valor desse parâmetro for false, a função consultará os dados da tabela AzureDiagnostics e das tabelas específicas do recurso. Se o valor desse parâmetro for true, a função consultará somente os dados das tabelas específicas do recurso. O valor padrão é true. | N | true | Boolean |
| BackupSolutionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de soluções de backup usadas no ambiente do Azure. Por exemplo, se você especificar Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM como o valor desse parâmetro, a função retornará somente os registros relacionados aos itens de backup que usam backup de Máquina Virtual do Azure, SQL no backup de VM do Azure ou DPM para o backup do Azure. Por padrão, o valor desse parâmetro é '*', o que faz com que a função retorne os registros relativos a todas as soluções de backup com suporte nos Relatórios de Backup (os valores com suporte são "Backup de Máquina Virtual do Azure", "SQL no Backup de VM do Azure", "SAP HANA no Backup de VM do Azure", "Backup de Armazenamento do Azure (Arquivos do Azure)", "Agente de Backup do Azure", "DPM", "Servidor de Backup do Azure", Banco de Dados PostgreSQL do Azure, Backup de Blob do Azure, Backup de Disco do Azure ou uma combinação separada por vírgula de qualquer um desses valores). |
N | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| ProtectionInfoList | Use este parâmetro para escolher se deseja incluir somente as instâncias de backup que estão ativamente protegidas ou também as instâncias com a proteção interrompida e as instâncias com o backup inicial está pendente. Para cargas de trabalho do cofre dos serviços de recuperação, os valores com suporte são "Protected", "ProtectionStopped", "InitialBackupPending" ou uma combinação separada por vírgula de qualquer um desses valores. Para cargas de trabalho do cofre de backup, os valores com suporte são "Protected", "ConfiguringProtection", "ConfiguringProtectionFailed", "UpdatingProtection", "ProtectionError", "ProtectionStopped" ou uma combinação separada por vírgulas de qualquer um desses valores. Por padrão, o valor é "*", o que faz com que a função pesquise todas as instâncias de backup, independentemente dos detalhes da proteção. | N | "Protected" | String |
| DatasourceSetName | Use este parâmetro para filtrar a saída da função para um recurso pai específico. Por exemplo, para retornar o SQL nas instâncias de backup de VM do Azure que pertencem à máquina virtual "testvm", especifique testvm como o valor desse parâmetro. Por padrão, o valor é "*", o que faz com que a função pesquise registros em todas as instâncias de backup. | N | "testvm" | String |
| BackupInstanceName | Use este parâmetro para pesquisar uma instância de backup específica por nome. Por padrão, o valor é "*", o que faz com que a função pesquise todas as instâncias de backup. | N | "testvm" | String |
| DisplayAllFields | Use este parâmetro para escolher se deseja recuperar apenas um subconjunto dos campos retornados pela função. Se o valor desse parâmetro for false, a função eliminará as informações relacionadas ao armazenamento e ao ponto de retenção da saída da função. Isto será útil caso esteja usando essa função como etapa intermediária em uma consulta maior e precisar otimizar o desempenho da consulta, eliminando as colunas que você não precisa para análise. Por padrão, o valor desse parâmetro é true, o que faz com que a função retorne todos os campos relativos à instância de backup. | N | true | Boolean |
| AggregationType | Use este parâmetro para especificar a granularidade de tempo em que os dados devem ser recuperados. Se o valor desse parâmetro for "Daily", a função retornará um registro por instância de backup por dia, permitindo que você analise as tendências diárias do consumo de armazenamento e da contagem de instâncias de backup. Se o valor desse parâmetro for "Weekly", a função retornará um registro por instância de backup por semana, permitindo que você analise as tendências semanais. Da mesma forma, você pode especificar "Monthly" para analisar as tendências mensais. O valor padrão é "Daily". Caso esteja exibindo dados em intervalos de tempo maiores, é recomendável usar “Weekly” ou “Monthly”, para obter um melhor desempenho de consulta e facilitar a análise de tendência. | N | "Weekly" | String |
Campos retornados
| Nome do Campo | Descrição | Data type |
|---|---|---|
| UniqueId | Chave primária que indica a ID exclusiva da instância de backup | String |
| ID | ID da instância de backup no ARM (Azure Resource Manager) | String |
| FriendlyName | Nome amigável da instância de backup | String |
| ProtectionInfo | Informações sobre as configurações de proteção da instância de backup. Por exemplo, a proteção está configurada, proteção interrompida, backup inicial pendente | String |
| LatestRecoveryPoint | Data e hora do ponto de recuperação mais recente associado à instância de backup. Atualmente, esse campo só tem suporte para cargas de trabalho do cofre dos Serviços de Recuperação | DateTime |
| OldestRecoveryPoint | Data e hora do ponto de recuperação mais antigo associado à instância de backup | Atualmente, esse campo só tem suporte para cargas de trabalho do cofre dos Serviços de Recuperação |
| SourceSizeInMBs | Tamanho de front-end da instância de backup em MBs | Double |
| VaultStore_StorageConsumptionInMBs | Total de armazenamento em nuvem consumido pela instância de backup na camada standard do cofre | Double |
| DataSourceFriendlyName | Nome amigável da fonte de dados correspondente à instância de backup | String |
| BackupSolution | Solução de Backup à qual a instância de backup está associada. Por exemplo, Backup de VM do Azure, SQL no Backup de VM do Azure e assim por diante. | String |
| DatasourceType | Tipo da fonte de dados correspondente à instância de backup. Por exemplo, "Microsoft.Compute/virtualMachines" | String |
| DatasourceResourceId | ID da fonte de dados subjacente no ARM (Azure Resource Manager) correspondente à instância de backup. Por exemplo, ID da VM no ARM (Azure Resource Manager) | String |
| DatasourceSetFriendlyName | Nome amigável do recurso pai da fonte de dados (sempre que aplicável). Por exemplo, para um SQL na fonte de dados da VM do Azure, esse campo conterá o nome da VM em que existe o banco de dados SQL | String |
| DatasourceSetResourceId | ID do recurso pai da fonte de dados no ARM (Azure Resource Manager) (sempre que aplicável). Por exemplo, para um SQL na fonte de dados da VM do Azure, esse campo conterá a ID da VM no ARM (Azure Resource Manager), na qual existe o banco de dados SQL | String |
| DatasourceSetType | Tipo do recurso pai da fonte de dados (sempre que aplicável). Por exemplo, para um SAP HANA na fonte de dados da VM do Azure, esse campo será Microsoft.Compute/virtualMachines, pois o recurso pai é uma VM do Azure | String |
| PolicyName | Nome da política associada à instância de backup | String |
| PolicyUniqueId | Chave estrangeira que se refere à política associada à instância de backup | String |
| PolicyId | ID da política associada à instância de backup no ARM (Azure Resource Manager) | String |
| VaultResourceId | ID do cofre associado à instância de backup no ARM (Azure Resource Manager) | String |
| VaultUniqueId | Chave estrangeira que se refere ao cofre associado à instância de backup | String |
| VaultName | Nome do cofre associado à instância de backup | String |
| VaultTags | Marcações do cofre associado à instância de backup | String |
| VaultSubscriptionId | ID de assinatura do cofre associado à instância de backup | String |
| VaultLocation | Local do cofre associado à instância de backup | String |
| VaultStore_StorageReplicationType | Tipo de Replicação de Armazenamento do cofre associado à instância de backup | String |
| VaultType | Tipo do cofre, por exemplo, "Microsoft.RecoveryServices/vaults" ou "Microsoft.DataProtection/backupVaults" | String |
| TimeGenerated | Carimbo de data/hora do registro | DateTime |
_AzureBackup_GetBillingGroupsTrends()
Esta função retorna os registros históricos de cada entidade de cobrança, permitindo exibir as principais tendências diárias, semanais e mensais relacionadas ao tamanho de front-end e ao consumo de armazenamento, em vários níveis de granularidade.
Parâmetros
| Nome do parâmetro | Descrição | Obrigatório? | Valor de exemplo | Data type |
|---|---|---|---|---|
| RangeStart | Use este parâmetro juntamente com o parâmetro RangeEnd para recuperar todos os registros relacionados ao grupo de cobrança no período entre RangeStart e RangeEnd. | S | "2021-03-03 00:00:00" | Datetime |
| RangeEnd | Use este parâmetro juntamente com o parâmetro RangeStart para recuperar todos os registros relacionados ao grupo de cobrança no período entre RangeStart e RangeEnd. | S | "2021-03-10 00:00:00" | DateTime |
| VaultSubscriptionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de assinaturas em que existem dados de backup. Especificar uma lista separada por vírgula de IDs de assinatura como parâmetro para essa função ajuda a recuperar somente os grupos de cobrança que estão nas assinaturas especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as assinaturas. | N | "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | String |
| VaultLocationList | Use este parâmetro para filtrar a saída da função para determinado conjunto de regiões em que existem dados de backup. Especificar uma lista separada por vírgula de regiões como parâmetro para essa função ajuda a recuperar somente os grupos de cobrança que estão nas regiões especificadas. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros em todas as regiões. | N | eastus,westus |
String |
| VaultList | Use este parâmetro para filtrar a saída da função para determinado conjunto de cofres. Especificar uma lista separada por vírgula de nomes de cofre como parâmetro para essa função ajuda a recuperar somente os registros de instâncias de backup relativas aos cofres especificados. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise registros de grupos de cobrança em todos cofres. | N | vault1,vault2,vault3 |
String |
| VaultTypeList | Use este parâmetro para filtrar a saída da função para os registros relativos a um tipo de cofre específico. Por padrão, o valor desse parâmetro é '*', o que faz com que a função pesquise cofres dos Serviços de Recuperação e cofres de Backup. | N | "Microsoft.RecoveryServices/vaults" | String |
| ExcludeLegacyEvent | Use este parâmetro para escolher se deseja consultar dados na tabela herdada AzureDiagnostics. Se o valor desse parâmetro for false, a função consultará os dados da tabela AzureDiagnostics e das tabelas específicas do recurso. Se o valor desse parâmetro for true, a função consultará somente os dados das tabelas específicas do recurso. O valor padrão é true. | N | true | Boolean |
| BackupSolutionList | Use este parâmetro para filtrar a saída da função para determinado conjunto de soluções de backup usadas no ambiente do Azure. Por exemplo, se você especificar Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM como o valor desse parâmetro, a função retornará somente os registros relacionados aos itens de backup que usam backup de Máquina Virtual do Azure, SQL no backup de VM do Azure ou DPM para o backup do Azure. Por padrão, o valor desse parâmetro é '*', o que faz com que a função retorne os registros relativos a todas as soluções de backup com suporte nos Relatórios de Backup (os valores com suporte são "Backup de Máquina Virtual do Azure", "SQL no Backup de VM do Azure", "SAP HANA no Backup de VM do Azure", "Backup de Armazenamento do Azure (Arquivos do Azure)", "Agente de Backup do Azure", "DPM", "Servidor de Backup do Azure", Banco de Dados PostgreSQL do Azure, Backup de Blob do Azure, Backup de Disco do Azure ou uma combinação separada por vírgula de qualquer um desses valores). |
N | Azure Virtual Machine Backup,SQL in Azure VM Backup,DPM,Azure Backup Agent |
String |
| BillingGroupName | Use este parâmetro para pesquisar um grupo de cobrança específico por nome. Por padrão, o valor é "*", o que faz com que a função pesquise todos os grupos de cobrança. | N | "testvm" | String |
| AggregationType | Use este parâmetro para especificar a granularidade de tempo em que os dados devem ser recuperados. Se o valor desse parâmetro for "Daily", a função retornará um registro por grupo de cobrança por dia, permitindo que você analise as tendências diárias do consumo de armazenamento e do tamanho de front-end. Se o valor desse parâmetro for "Weekly", a função retornará um registro por instância de backup por semana, permitindo que você analise as tendências semanais. Da mesma forma, você pode especificar "Monthly" para analisar as tendências mensais. O valor padrão é "Daily". Caso esteja exibindo dados em intervalos de tempo maiores, é recomendável usar “Weekly” ou “Monthly”, para obter um melhor desempenho de consulta e facilitar a análise de tendência. | N | "Weekly" | String |
Campos retornados
| Nome do Campo | Descrição | Data type |
|---|---|---|
| UniqueId | Chave primária que indica a ID exclusiva do grupo de cobrança | String |
| FriendlyName | Nome amigável do grupo de cobrança | String |
| Nome | Nome do grupo de cobrança | String |
| Type | Tipo do grupo de cobrança. Por exemplo, ProtectedContainer ou BackupItem | String |
| SourceSizeInMBs | Tamanho de front-end do grupo de cobrança em MBs | Double |
| VaultStore_StorageConsumptionInMBs | Total de armazenamento em nuvem consumido pelo grupo de cobrança na camada standard do cofre | Double |
| BackupSolution | Solução de Backup à qual o grupo de cobrança está associado. Por exemplo, Backup de VM do Azure, SQL no Backup de VM do Azure e assim por diante. | String |
| VaultResourceId | ID do cofre associado ao grupo de cobrança no ARM (Azure Resource Manager) | String |
| VaultUniqueId | Chave estrangeira que se refere ao cofre associado ao grupo de cobrança | String |
| VaultName | Nome do cofre associado ao grupo de cobrança | String |
| VaultTags | Marcações do cofre associado ao grupo de cobrança | String |
| VaultSubscriptionId | ID de assinatura do cofre associado ao grupo de cobrança | String |
| VaultLocation | Local do cofre associado ao grupo de cobrança | String |
| VaultStore_StorageReplicationType | Tipo de Replicação de Armazenamento do cofre associado ao grupo de cobrança | String |
| VaultType | Tipo do cofre, por exemplo, "Microsoft.RecoveryServices/vaults" ou "Microsoft.DataProtection/backupVaults" | String |
| TimeGenerated | Carimbo de data/hora do registro | DateTime |
| ExtendedProperties | Propriedades adicionais do grupo de cobrança | Dinâmico |
Consultas de exemplo
Veja abaixo algumas consultas de exemplo para ajudar você a começar a usar as funções do sistema.
Todos os trabalhos de backup de VM do Azure com falha em determinado intervalo de tempo
_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=DataTransferredInMBsTodos os trabalhos de backup de log do SQL em determinado intervalo de tempo
_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=DataTransferredInMBsTendência semanal do armazenamento de backup consumido para a VM "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