Product Template - Get

Serviço:: Sentinel

Versão da API:: 2025-09-01

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 do URI

Name	Em	Obrigatório	Tipo	Descrição
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 um 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 espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Descrição
200 OK	productTemplateModel	Operação do Azure concluída com sucesso.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get a template.

Pedido de amostra

HTTP

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 da amostra

Código de estado:: 200

{
  "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

Name	Descrição
CloudError	Estrutura de resposta a erros.
CloudErrorBody	Detalhes do erro.
createdByType	O tipo de identidade que criou o recurso.
Flag	O valor booleano destinado aos metadados.
Kind	O tipo de conteúdo para o qual os metadados se destinam.
metadataAuthor	Editor 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 operador/critério para dependências complexas.
MetadataDependencyOperator	Operador usado para lista de dependências na matriz de critérios.
metadataSource	A fonte original do item de conteúdo, de onde ele vem.
metadataSupport	Informações de suporte para o item de conteúdo.
PackageKind	O tipo de embalagem
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 referentes à criação e última modificação do recurso.

CloudError

Object

Estrutura de resposta a erros.

Name	Tipo	Descrição
error	CloudErrorBody	Dados de erro

CloudErrorBody

Object

Detalhes do erro.

Name	Tipo	Descrição
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

Flag

Enumeração

O valor booleano destinado aos metadados.

Valor	Descrição
true	true
false	false

Kind

Enumeração

O tipo de conteúdo para o qual os metadados se destinam.

Valor	Descrição
DataConnector	DataConnector
DataType	Tipo de Dados
Workbook	Livro de trabalho
WorkbookTemplate	WorkbookTemplate
Playbook	Manual de Estratégia
PlaybookTemplate	PlaybookTemplate
AnalyticsRuleTemplate	AnalyticsRuleTemplate
AnalyticsRule	AnalyticsRule
HuntingQuery	HuntingQuery
InvestigationQuery	InvestigaçãoConsulta
Parser	Analisador
Watchlist	Watchlist
WatchlistTemplate	WatchlistTemplate
Solution	Solução
AzureFunction	AzureFunction
LogicAppsCustomConnector	LogicAppsCustomConnector
AutomationRule	AutomationRule
ResourcesDataConnector	ResourcesDataConnector
Notebook	Notebook
Standalone	Autónomo
SummaryRule	SummaryRule

metadataAuthor

Object

Editor ou criador do item de conteúdo.

Name	Tipo	Descrição
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

Object

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

Name	Tipo	Descrição
domains	string[]	domínio para o item de conteúdo da solução
verticals	string[]	Verticais do setor para o item de conteúdo da solução

metadataDependencies

Object

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 operador/critério para dependências complexas.

Name	Tipo	Descrição
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	MetadataDependencyOperator	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 faltando para indicar que qualquer versão preenche a dependência. Se a versão não corresponder ao nosso formato numérico definido, então é necessária uma correspondência exata.

MetadataDependencyOperator

Enumeração

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

Valor	Descrição
AND	AND
OR	OR

metadataSource

Object

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

Name	Tipo	Descrição
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 espaço de trabalho LA, etc.
sourceId	string	ID da fonte de conteúdo. O ID da solução, ID do espaço de trabalho, etc

metadataSupport

Object

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

Name	Tipo	Descrição
email	string	E-mail de contato de suporte
link	string	Link para ajuda de suporte, como página de suporte para abrir um ticket, etc.
name	string	Nome do contato de suporte. Empresa ou pessoa.
tier	SupportTier	Tipo de suporte para item de conteúdo

PackageKind

Enumeração

O tipo de embalagem

Valor	Descrição
Solution	Solução
Standalone	Autónomo

productTemplateModel

Object

Definição de recurso de modelo.

Name	Tipo	Descrição
etag	string	Etag do recurso azure
id	string (arm-id)	ID de recurso totalmente qualificado 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 criação 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 no 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/kind/version pode ser fornecido ou operador/critério para formatos complexos.
properties.displayName	string	O nome para 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 obtido posteriormente nos metadados de conteúdo
properties.isDeprecated	Flag	Sinalizador indica se este modelo foi preterido
properties.lastPublishDate	string (date)	Data da última publicação do item de conteúdo
properties.packageId	string	o ID do pacote contém este modelo
properties.packageKind	PackageKind	o packageKind do 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 ARM. Também pode ser qualquer string, mas então não podemos garantir nenhuma verificação de versão
properties.packagedContent		O json do modelo ARM a ser implantado
properties.previewImages	string[]	Visualize nomes de arquivos de imagem. Estes serão retirados dos artefatos da solução
properties.previewImagesDark	string[]	Visualize nomes de arquivos de imagem. Estes 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. É aqui / 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 abrange, estas têm de estar alinhadas com as táticas que estão a ser utilizadas
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 ARM. Também pode ser qualquer string, mas então não podemos garantir nenhuma verificação de versão
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SourceKind

Enumeração

Tipo de fonte do conteúdo

Valor	Descrição
LocalWorkspace	LocalWorkspace
Community	Community
Solution	Solução
SourceRepository	SourceRepository

SupportTier

Enumeração

Tipo de suporte para item de conteúdo

Valor	Descrição
Microsoft	Microsoft
Partner	Partner
Community	Community

systemData

Object

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

Name	Tipo	Descrição
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.