Compartilhar via


Product Template - Get

Obtém um modelo por seu identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentproducttemplates/{templateId}?api-version=2025-09-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.

templateId
path True

string

ID do modelo

workspaceName
path True

string

minLength: 1
maxLength: 90
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

O nome do workspace.

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

productTemplateModel

OKEY

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Get a template.

Solicitação de exemplo

GET https://management.azure.com/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentproducttemplates/8365ebfe-a381-45b7-ad08-7d818070e11f?api-version=2025-09-01

Resposta de exemplo

{
  "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentProductTemplates/8365ebfe-a381-45b7-ad08-7d818070e11f",
  "name": "8365ebfe-a381-45b7-ad08-7d818070e11f",
  "type": "Microsoft.SecurityInsights/contentproducttemplates",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "contentId": "contentId",
    "version": "1.0.0",
    "packageVersion": "1.0.0",
    "displayName": "My installed template",
    "contentKind": "Workbooks",
    "contentProductId": "packageId-wb-rimnsoeh4nt32",
    "packageId": "packageId",
    "packageKind": "Standalone",
    "packageName": "package name",
    "source": {
      "kind": "Standalone",
      "name": "Source name"
    },
    "mainTemplate": {}
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-27T21:53:29.0928001Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-27T21:53:29.0928001Z"
  }
}

Definições

Nome Description
CloudError

Estrutura de resposta de erro.

CloudErrorBody

Detalhes do erro.

createdByType

O tipo de identidade que criou o recurso.

flag

O sinalizador indica se este modelo está obsoleto

kind

O tipo de conteúdo para o qual o modelo se destina.

metadataAuthor

Publicador ou criador do item de conteúdo.

metadataCategories

ies para o item de conteúdo da solução

metadataDependencies

Dependências para o item de conteúdo, quais outros itens de conteúdo ele requer para funcionar. Pode descrever dependências mais complexas usando uma estrutura recursiva/aninhada. Para uma única dependência, um id/kind/version pode ser fornecido ou operator/criteria para dependências complexas.

metadataSource

A fonte original do item de conteúdo, de onde ele vem.

metadataSupport

Informações de suporte para o item de conteúdo.

operator

Operador usado para lista de dependências na matriz de critérios.

packageKind

o pacoteO tipo de pacote contém este modelo

productTemplateModel

Definição de recurso de modelo.

sourceKind

Tipo de fonte do conteúdo

supportTier

Tipo de suporte para item de conteúdo

systemData

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

CloudError

Estrutura de resposta de erro.

Nome Tipo Description
error

CloudErrorBody

Dados de erro

CloudErrorBody

Detalhes do erro.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.

message

string

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

createdByType

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

flag

O sinalizador indica se este modelo está obsoleto

Valor Description
true
false

kind

O tipo de conteúdo para o qual o modelo se destina.

Valor Description
DataConnector
DataType
Workbook
WorkbookTemplate
Playbook
PlaybookTemplate
AnalyticsRuleTemplate
AnalyticsRule
HuntingQuery
InvestigationQuery
Parser
Watchlist
WatchlistTemplate
Solution
AzureFunction
LogicAppsCustomConnector
AutomationRule
ResourcesDataConnector

Os conectores da plataforma de conector sem código (CCP)

Notebook

Blocos de anotações Jupyter

Standalone

Conteúdo único/autônomo contribuído por colaboradores da comunidade

SummaryRule

As regras de resumo executam o processamento em lote diretamente no workspace do Log Analytics.

metadataAuthor

Publicador ou criador do item de conteúdo.

Nome Tipo Description
email

string

E-mail de contato do autor

link

string

Link para a página do autor/fornecedor

name

string

Nome do autor. Empresa ou pessoa.

metadataCategories

ies para o item de conteúdo da solução

Nome Tipo Description
domains

string[]

domínio para o item de conteúdo da solução

verticals

string[]

Verticais da indústria para o item de conteúdo da solução

metadataDependencies

Dependências para o item de conteúdo, quais outros itens de conteúdo ele requer para funcionar. Pode descrever dependências mais complexas usando uma estrutura recursiva/aninhada. Para uma única dependência, um id/kind/version pode ser fornecido ou operator/criteria para dependências complexas.

Nome Tipo Description
contentId

string

ID do item de conteúdo do qual dependemos

criteria

metadataDependencies[]

Esta é a lista de dependências que devemos cumprir, de acordo com o operador AND/OR

kind

kind

Tipo do item de conteúdo do qual dependemos

name

string

Nome do item de conteúdo

operator

operator

Operador usado para lista de dependências na matriz de critérios.

version

string

Versão do item de conteúdo do qual dependemos. Pode estar em branco, * ou ausente para indicar que qualquer versão atende à dependência. Se a versão não corresponder ao nosso formato numérico definido, uma correspondência exata será necessária.

metadataSource

A fonte original do item de conteúdo, de onde ele vem.

Nome Tipo Description
kind

sourceKind

Tipo de fonte do conteúdo

name

string

Nome da fonte de conteúdo. O nome do repositório, o nome da solução, o nome do workspace de LA etc.

sourceId

string

ID da fonte de conteúdo. A ID da solução, a ID do espaço de trabalho etc.

metadataSupport

Informações de suporte para o item de conteúdo.

Nome Tipo Description
email

string

E-mail do contato de suporte

link

string

Link para ajuda de suporte, como a página de suporte para abrir um tíquete etc.

name

string

Nome do contato de suporte. Empresa ou pessoa.

tier

supportTier

Tipo de suporte para item de conteúdo

operator

Operador usado para lista de dependências na matriz de critérios.

Valor Description
AND
OR

packageKind

o pacoteO tipo de pacote contém este modelo

Valor Description
Solution
Standalone

productTemplateModel

Definição de recurso de modelo.

Nome Tipo Description
etag

string

Etag do recurso do azure

id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

O nome do recurso

properties.author

metadataAuthor

O criador do item de conteúdo.

properties.categories

metadataCategories

Categorias para o item

properties.contentId

string

ID estático para o conteúdo. Usado para identificar dependências e conteúdo de soluções ou comunidade. Codificado/estático para conteúdo e soluções prontos para uso. Dinâmico para criado pelo usuário. Este é o nome do recurso

properties.contentKind

kind

O tipo de conteúdo para o qual o modelo se destina.

properties.contentProductId

string

ID exclusivo para o conteúdo. Ele deve ser gerado com base no contentId do pacote, contentId do modelo, contentKind do modelo e contentVersion do modelo

properties.contentSchemaVersion

string

Versão do esquema do conteúdo. Pode ser usado para distinguir entre diferentes fluxos com base na versão do esquema

properties.customVersion

string

A versão personalizada do conteúdo. Um texto livre opcional

properties.dependencies

metadataDependencies

Dependências para o item de conteúdo, quais outros itens de conteúdo ele requer para funcionar. Pode descrever dependências mais complexas usando uma estrutura recursiva/aninhada. Para uma única dependência, um id/tipo/versão pode ser fornecido ou operador/critérios para formatos complexos.

properties.displayName

string

O nome de exibição do modelo

properties.firstPublishDate

string (date)

item de conteúdo da primeira data de publicação

properties.icon

string

o identificador do ícone. Esse ID pode ser buscado posteriormente nos metadados de conteúdo

properties.isDeprecated

flag

O sinalizador indica se este modelo está obsoleto

properties.lastPublishDate

string (date)

Última data de publicação do item de conteúdo

properties.packageId

string

o ID do pacote contém este modelo

properties.packageKind

packageKind

o pacoteO tipo de pacote contém este modelo

properties.packageName

string

O nome do pacote contém este modelo

properties.packageVersion

string

Versão do pacote. O formato padrão e recomendado é numérico (por exemplo, 1, 1.0, 1.0.0, 1.0.0.0), seguindo as práticas recomendadas de metadados do ARM. Também pode ser qualquer string, mas não podemos garantir nenhuma verificação de versão

properties.packagedContent

object

O json do modelo do ARM a ser implantado

properties.previewImages

string[]

Visualize os nomes dos arquivos de imagem. Eles serão retirados dos artefatos da solução

properties.previewImagesDark

string[]

Visualize os nomes dos arquivos de imagem. Eles serão retirados dos artefatos da solução. usado para suporte a temas escuros

properties.providers

string[]

Provedores para o item de conteúdo

properties.source

metadataSource

Fonte do conteúdo. Este é o lugar / como foi criado.

properties.support

metadataSupport

Informações de suporte para o modelo - tipo, nome, informações de contato

properties.threatAnalysisTactics

string[]

As táticas que o recurso cobre

properties.threatAnalysisTechniques

string[]

as técnicas que o recurso cobre, elas devem estar alinhadas com as táticas que estão sendo usadas

properties.version

string

Versão do conteúdo. O formato padrão e recomendado é numérico (por exemplo, 1, 1.0, 1.0.0, 1.0.0.0), seguindo as práticas recomendadas de metadados do ARM. Também pode ser qualquer string, mas não podemos garantir nenhuma verificação de versão

systemData

systemData

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

type

string

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

sourceKind

Tipo de fonte do conteúdo

Valor Description
LocalWorkspace
Community
Solution
SourceRepository

supportTier

Tipo de suporte para item de conteúdo

Valor Description
Microsoft
Partner
Community

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.