Compartilhar via


Grafana - List

Liste todos os recursos de workspaces para Grafana na assinatura especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Dashboard/grafana?api-version=2023-09-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
subscriptionId
path True

string

minLength: 1

A ID da assinatura de destino.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

ManagedGrafanaListResponse

OKEY. Retorne todos os recursos de workspaces para Grafana na assinatura especificada.

Other Status Codes

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha.

Exemplos

Grafana_List

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/grafana?api-version=2023-09-01

Resposta de exemplo

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace",
      "name": "myWorkspace",
      "type": "Microsoft.Dashboard/grafana",
      "sku": {
        "name": "Standard"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "grafanaVersion": "9.4.5",
        "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com",
        "zoneRedundancy": "Enabled",
        "apiKey": "Enabled",
        "deterministicOutboundIP": "Enabled",
        "outboundIPs": [
          "192.168.0.1",
          "192.168.0.2"
        ],
        "publicNetworkAccess": "Enabled",
        "autoGeneratedDomainNameLabelScope": "TenantReuse",
        "grafanaConfigurations": {
          "smtp": {
            "enabled": true,
            "host": "smtp.sendemail.com:587",
            "user": "username",
            "fromAddress": "test@sendemail.com",
            "fromName": "emailsender",
            "startTLSPolicy": "OpportunisticStartTLS",
            "skipVerify": true
          }
        },
        "grafanaIntegrations": {
          "azureMonitorWorkspaceIntegrations": [
            {
              "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace"
            }
          ]
        },
        "enterpriseConfigurations": {
          "marketplacePlanId": "myPlanId",
          "marketplaceAutoRenew": "Enabled"
        },
        "grafanaPlugins": {
          "sample-plugin-id": {
            "pluginId": "sample-plugin-id"
          }
        },
        "grafanaMajorVersion": "9"
      },
      "tags": {
        "Environment": "Dev"
      },
      "location": "West US"
    }
  ]
}

Definições

Nome Description
ApiKey
AutoGeneratedDomainNameLabelScope

Escopo para cálculo de hash de nome determinístico de dns

AzureMonitorWorkspaceIntegration

Integrações para o Workspace do Azure Monitor.

createdByType

O tipo de identidade que criou o recurso.

DeterministicOutboundIP
EnterpriseConfigurations

Configurações corporativas de uma instância do Grafana

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

GrafanaConfigurations

Configurações de servidor de uma instância do Grafana

GrafanaIntegrations

GrafanaIntegrations é uma experiência de observabilidade agrupada (por exemplo, fonte de dados pré-configurada, painéis grafana personalizados, padrões de alerta) para cenários comuns de monitoramento.

GrafanaPlugin

Plug-in do Grafana

ManagedGrafana

O tipo de recurso grafana.

ManagedGrafanaListResponse
ManagedGrafanaProperties

Propriedades específicas do recurso grafana.

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

MarketplaceAutoRenew

A configuração AutoRenew da assinatura Enterprise

PrivateEndpoint

O recurso de ponto de extremidade privado.

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

PrivateEndpointServiceConnectionStatus

O status da conexão do ponto de extremidade privado.

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

ProvisioningState
PublicNetworkAccess

Indique o estado para habilitar ou desabilitar o tráfego pela interface pública.

ResourceSku
Smtp

Configurações do servidor de email. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp

StartTLSPolicy

A configuração StartTLSPolicy do https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy de configuração do SMTP

systemData

Metadados relativos à criação e última modificação do recurso.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

ZoneRedundancy

ApiKey

Valor Description
Disabled
Enabled

AutoGeneratedDomainNameLabelScope

Escopo para cálculo de hash de nome determinístico de dns

Valor Description
TenantReuse

AzureMonitorWorkspaceIntegration

Integrações para o Workspace do Azure Monitor.

Nome Tipo Description
azureMonitorWorkspaceResourceId

string

A ID do recurso do Workspace do Azure Monitor conectado.

createdByType

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

DeterministicOutboundIP

Valor Description
Disabled
Enabled

EnterpriseConfigurations

Configurações corporativas de uma instância do Grafana

Nome Tipo Description
marketplaceAutoRenew

MarketplaceAutoRenew

A configuração AutoRenew da assinatura Enterprise

marketplacePlanId

string

A ID do plano da assinatura do Azure Marketplace para os plug-ins enterprise

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

GrafanaConfigurations

Configurações de servidor de uma instância do Grafana

Nome Tipo Description
smtp

Smtp

Configurações do servidor de email. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp

GrafanaIntegrations

GrafanaIntegrations é uma experiência de observabilidade agrupada (por exemplo, fonte de dados pré-configurada, painéis grafana personalizados, padrões de alerta) para cenários comuns de monitoramento.

Nome Tipo Description
azureMonitorWorkspaceIntegrations

AzureMonitorWorkspaceIntegration[]

Integrações para o Workspace do Azure Monitor.

GrafanaPlugin

Plug-in do Grafana

Nome Tipo Description
pluginId

string

ID do plug-in do Grafana

ManagedGrafana

O tipo de recurso grafana.

Nome Tipo Description
id

string

ID do ARM do recurso grafana

identity

ManagedServiceIdentity

A identidade gerenciada do recurso grafana.

location

string

A localização geográfica em que o recurso grafana reside

name

string

Nome do recurso grafana.

properties

ManagedGrafanaProperties

Propriedades específicas do recurso grafana.

sku

ResourceSku

O Sku do recurso grafana.

systemData

systemData

Os metadados do sistema relacionados a esse recurso grafana.

tags

object

As marcas do recurso grafana.

type

string

O tipo do recurso grafana.

ManagedGrafanaListResponse

Nome Tipo Description
nextLink

string

value

ManagedGrafana[]

O tipo de recurso grafana.

ManagedGrafanaProperties

Propriedades específicas do recurso grafana.

Nome Tipo Valor padrão Description
apiKey

ApiKey

Disabled

A configuração da chave de api da instância do Grafana.

autoGeneratedDomainNameLabelScope

AutoGeneratedDomainNameLabelScope

Escopo para cálculo de hash de nome determinístico de dns.

deterministicOutboundIP

DeterministicOutboundIP

Disabled

Se uma instância do Grafana usa IPs de saída determinísticos.

endpoint

string

O ponto de extremidade da instância do Grafana.

enterpriseConfigurations

EnterpriseConfigurations

Configurações corporativas de uma instância do Grafana

grafanaConfigurations

GrafanaConfigurations

Configurações de servidor de uma instância do Grafana

grafanaIntegrations

GrafanaIntegrations

GrafanaIntegrations é uma experiência de observabilidade agrupada (por exemplo, fonte de dados pré-configurada, painéis grafana personalizados, padrões de alerta) para cenários comuns de monitoramento.

grafanaMajorVersion

string

A versão principal do software Grafana a ser direcionada.

grafanaPlugins

<string,  GrafanaPlugin>

Lista de plug-ins instalada da instância do Grafana. Chave é id de plug-in, valor é definição de plug-in.

grafanaVersion

string

A versão do software Grafana.

outboundIPs

string[]

Lista de IPs de saída se deterministicOutboundIP estiver habilitado.

privateEndpointConnections

PrivateEndpointConnection[]

As conexões de ponto de extremidade privado da instância do Grafana.

provisioningState

ProvisioningState

Estado de provisionamento do recurso.

publicNetworkAccess

PublicNetworkAccess

Enabled

Indique o estado para habilitar ou desabilitar o tráfego pela interface pública.

zoneRedundancy

ZoneRedundancy

Disabled

A configuração de redundância de zona da instância do Grafana.

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)

Nome Tipo Description
principalId

string (uuid)

A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.

tenantId

string (uuid)

A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.

type

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

userAssignedIdentities

<string,  UserAssignedIdentity>

Identidades de User-Assigned
O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

Valor Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MarketplaceAutoRenew

A configuração AutoRenew da assinatura Enterprise

Valor Description
Disabled
Enabled

PrivateEndpoint

O recurso de ponto de extremidade privado.

Nome Tipo Description
id

string

O identificador do ARM para o ponto de extremidade privado

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.groupIds

string[]

As IDs do grupo de conexão de ponto de extremidade privado.

properties.privateEndpoint

PrivateEndpoint

O recurso do ponto de extremidade privado.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

O estado de provisionamento do recurso de conexão de ponto de extremidade privado.

systemData

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Valor Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

O status da conexão do ponto de extremidade privado.

Valor Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Nome Tipo Description
actionsRequired

string

Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.

description

string

O motivo da aprovação/rejeição da conexão.

status

PrivateEndpointServiceConnectionStatus

Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

ProvisioningState

Valor Description
Accepted
Canceled
Creating
Deleted
Deleting
Failed
NotSpecified
Succeeded
Updating

PublicNetworkAccess

Indique o estado para habilitar ou desabilitar o tráfego pela interface pública.

Valor Description
Disabled
Enabled

ResourceSku

Nome Tipo Description
name

string

Smtp

Configurações do servidor de email. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp

Nome Tipo Valor padrão Description
enabled

boolean

False

Habilite isso para permitir que o Grafana envie emails. O padrão é false

fromAddress

string

Endereço usado ao enviar emails https://pkg.go.dev/net/mail#Address

fromName

string

Nome a ser usado ao enviar emails. O padrão é "Notificação do Grafana Gerenciado do Azure" https://pkg.go.dev/net/mail#Address

host

string

Nome do host do servidor SMTP com porta, por exemplo, test.email.net:587

password

string

Senha da autenticação SMTP. Se a senha contiver # ou ;, você precisará encapsule-a com aspas triplas

skipVerify

boolean

Verifique o servidor SSL para SMTP. O padrão é false https://pkg.go.dev/crypto/tls#Config

startTLSPolicy

StartTLSPolicy

A configuração StartTLSPolicy do https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy de configuração do SMTP

user

string

Usuário de autenticação SMTP

StartTLSPolicy

A configuração StartTLSPolicy do https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy de configuração do SMTP

Valor Description
MandatoryStartTLS
NoStartTLS
OpportunisticStartTLS

systemData

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Nome Tipo Description
clientId

string (uuid)

A ID do cliente da identidade atribuída.

principalId

string (uuid)

A ID da entidade de segurança da identidade atribuída.

ZoneRedundancy

Valor Description
Disabled
Enabled