Product Template - Get

Служба:: Sentinel

Версия API:: 2025-09-01

Получает шаблон по его идентификатору.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
templateId	path	True	string	Идентификатор шаблона
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Имя рабочей области.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	productTemplateModel	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get a template.

Образец запроса

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

Пример ответа

Код состояния:: 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"
  }
}

Определения

Имя	Описание
CloudError	Структура ответа на ошибку.
CloudErrorBody	Сведения об ошибке.
createdByType	Тип удостоверения, создавшего ресурс.
Flag	Булевое значение, для которого предназначены метаданные.
Kind	Тип содержимого, для который предназначен метаданные.
metadataAuthor	Издатель или создатель элемента контента.
metadataCategories	ies для элемента содержимого решения
metadataDependencies	Зависимости для элемента контента, какие другие элементы контента ему требуются для работы. Может описывать более сложные зависимости, используя рекурсивную/вложенную структуру. Для одной зависимости может быть предоставлен id/kind/version или operator/criteria для сложных зависимостей.
MetadataDependencyOperator	Оператор, используемый для списка зависимостей в массиве критериев.
metadataSource	Первоисточник элемента контента, откуда он берется.
metadataSupport	Вспомогательная информация для элемента содержимого.
PackageKind	Тип пакета
productTemplateModel	Определение ресурса шаблона.
SourceKind	Тип источника контента
SupportTier	Тип поддержки элемента содержимого
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CloudError

Объект

Структура ответа на ошибку.

Имя	Тип	Описание
error	CloudErrorBody	Данные об ошибках

CloudErrorBody

Объект

Сведения об ошибке.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

Flag

Перечисление

Булевое значение, для которого предназначены метаданные.

Значение	Описание
true	true
false	false

Kind

Перечисление

Тип содержимого, для который предназначен метаданные.

Значение	Описание
DataConnector	DataConnector
DataType	Тип данных
Workbook	Рабочая тетрадь
WorkbookTemplate	WorkbookTemplate
Playbook	Справочник стратегий
PlaybookTemplate	Шаблон сборника схем
AnalyticsRuleTemplate	AnalyticsRuleTemplate
AnalyticsRule	AnalyticsRule
HuntingQuery	HuntingQuery
InvestigationQuery	РасследованиеЗапрос
Parser	Средство синтаксического анализа
Watchlist	Watchlist
WatchlistTemplate	Список наблюденияШаблон
Solution	Решение
AzureFunction	AzureFunction
LogicAppsCustomConnector	LogicAppsCustomConnector (Пользовательский соединитель)
AutomationRule	AutomationRule
ResourcesDataConnector	ResourcesDataConnector
Notebook	Notebook
Standalone	Автономный
SummaryRule	Правило Summary

metadataAuthor

Объект

Издатель или создатель элемента контента.

Имя	Тип	Описание
email	string	Электронная почта автора контактная информация
link	string	Ссылка на страницу автора/продавца
name	string	ФИО автора. Компания или частное лицо.

metadataCategories

Объект

ies для элемента содержимого решения

Имя	Тип	Описание
domains	string[]	домен для элемента содержимого решения
verticals	string[]	Отраслевые вертикали для элемента содержимого решения

metadataDependencies

Объект

Зависимости для элемента контента, какие другие элементы контента ему требуются для работы. Может описывать более сложные зависимости, используя рекурсивную/вложенную структуру. Для одной зависимости может быть предоставлен id/kind/version или operator/criteria для сложных зависимостей.

Имя	Тип	Описание
contentId	string	Id элемента контента, от которого мы зависим
criteria	metadataDependencies[]	Это список зависимостей, которые мы должны выполнить, в соответствии с оператором И/ИЛИ
kind	Kind	Тип элемента контента, от которого мы зависим
name	string	Имя элемента содержимого
operator	MetadataDependencyOperator	Оператор, используемый для списка зависимостей в массиве критериев.
version	string	Версия элемента контента, от которого мы зависим. Может быть пустым, * или отсутствующим, чтобы указать, что любая версия удовлетворяет зависимости. Если версия не соответствует заданному нами числовому формату, требуется точное соответствие.

MetadataDependencyOperator

Перечисление

Оператор, используемый для списка зависимостей в массиве критериев.

Значение	Описание
AND	И
OR	OR

metadataSource

Объект

Первоисточник элемента контента, откуда он берется.

Имя	Тип	Описание
kind	SourceKind	Тип источника контента
name	string	Имя источника содержимого. Имя репозитория, имя решения, имя рабочей области LA и т. д.
sourceId	string	Идентификатор источника содержимого. Идентификатор решения, идентификатор рабочей области и т. д

metadataSupport

Объект

Вспомогательная информация для элемента содержимого.

Имя	Тип	Описание
email	string	Электронная почта контактного лица службы поддержки
link	string	Ссылка на помощь в поддержке, например, на страницу поддержки для открытия тикета и т.д.
name	string	Имя контактного лица службы поддержки. Компания или частное лицо.
tier	SupportTier	Тип поддержки элемента содержимого

PackageKind

Перечисление

Тип пакета

Значение	Описание
Solution	Решение
Standalone	Автономный

productTemplateModel

Объект

Определение ресурса шаблона.

Имя	Тип	Описание
etag	string	Etag ресурса Azure
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.author	metadataAuthor	Создатель элемента контента.
properties.categories	metadataCategories	Категории для товара
properties.contentId	string	Статический идентификатор содержимого. Используется для определения зависимостей и содержимого от решений или сообщества. Жестко запрограммированный/статический для готового контента и решений. Динамический для созданного пользователем. Это имя ресурса
properties.contentKind	Kind	Тип контента, для которого предназначен шаблон.
properties.contentProductId	string	Уникальный идентификатор содержимого. Он должен быть сгенерирован на основе contentId пакета, contentId шаблона, contentKind шаблона и contentVersion шаблона
properties.contentSchemaVersion	string	Версия схемы содержимого. Может использоваться для различения различных потоков в зависимости от версии схемы
properties.customVersion	string	Пользовательская версия содержимого. Необязательный свободный текст
properties.dependencies	metadataDependencies	Зависимости для элемента контента, какие другие элементы контента ему требуются для работы. Может описывать более сложные зависимости, используя рекурсивную/вложенную структуру. Для одной зависимости может быть предоставлен id/kind/version или operator/criteria для сложных форматов.
properties.displayName	string	Отображаемое имя шаблона
properties.firstPublishDate	string (date)	Элемент содержимого с датой первой публикации
properties.icon	string	идентификатор иконки. Этот идентификатор позже может быть получен из метаданных содержимого
properties.isDeprecated	Flag	Флаг указывает, является ли этот шаблон устаревшим
properties.lastPublishDate	string (date)	Дата последней публикации элемента содержимого
properties.packageId	string	пакет Id содержит этот шаблон
properties.packageKind	PackageKind	packageKind пакета содержит этот шаблон
properties.packageName	string	Имя пакета содержит этот шаблон
properties.packageVersion	string	Версия пакета. По умолчанию рекомендуется использовать числовой формат (например, 1, 1.0, 1.0.0, 1.0.0.0) в соответствии с рекомендациями по метаданным ARM. Также может быть любая строка, но тогда мы не можем гарантировать никаких проверок версий
properties.packagedContent		json шаблона ARM для развертывания
properties.previewImages	string[]	Предварительный просмотр имен файлов изображений. Они будут взяты из артефактов решения
properties.previewImagesDark	string[]	Предварительный просмотр имен файлов изображений. Они будут взяты из артефактов решения. Используется для поддержки темных тем
properties.providers	string[]	Поставщики для элемента содержимого
properties.source	metadataSource	Источник контента. Вот где/как он был создан.
properties.support	metadataSupport	Вспомогательная информация для шаблона - тип, название, контактная информация
properties.threatAnalysisTactics	string[]	Тактика, которую освещает ресурс
properties.threatAnalysisTechniques	string[]	Методы, охватываемые ресурсом, должны быть согласованы с используемой тактикой
properties.version	string	Версия контента. По умолчанию рекомендуется использовать числовой формат (например, 1, 1.0, 1.0.0, 1.0.0.0) в соответствии с рекомендациями по метаданным ARM. Также может быть любая строка, но тогда мы не можем гарантировать никаких проверок версий
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SourceKind

Перечисление

Тип источника контента

Значение	Описание
LocalWorkspace	Локальное рабочее пространство
Community	Сообщество
Solution	Решение
SourceRepository	SourceRepository

SupportTier

Перечисление

Тип поддержки элемента содержимого

Значение	Описание
Microsoft	Microsoft
Partner	Partner
Community	Сообщество

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.