Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

sentinel content hub package and template API #23151

Merged
merged 6 commits into from
Apr 3, 2023
Merged

sentinel content hub package and template API #23151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d1a9a33
commit for content template and content package API
xuhumsft Mar 17, 2023
5cd1914
fix issues reported by swagger lint
xuhumsft Mar 20, 2023
660a283
add 201 for put requests in template service
xuhumsft Mar 20, 2023
c5c0387
resolve the comments
xuhumsft Mar 23, 2023
fd66b6e
resolve comments in packageId
xuhumsft Mar 31, 2023
6feb597
resolve comments
xuhumsft Mar 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
453 changes: 453 additions & 0 deletions ...source-manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentPackages.json
View file
Open in desktop

Large diffs are not rendered by default.

297 changes: 297 additions & 0 deletions ...manager/Microsoft.SecurityInsights/preview/2023-04-01-preview/ContentProductPackages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,297 @@
{
"swagger": "2.0",
"info": {
"title": "Security Insights",
"description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider",
"version": "2023-04-01-preview"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages": {
"get": {
"x-ms-examples": {
"Get all available packages.": {
"$ref": "./examples/contentPackages/GetProductPackages.json"
}
},
"tags": [
"ContentProductPackages"
],
"description": "Gets all packages from the catalog.",
"operationId": "ProductPackages_List",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/ODataFilter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/ODataTop"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/packageList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/2.0/types.json#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages/{packageId}": {
"get": {
"x-ms-examples": {
"Get a package.": {
"$ref": "./examples/contentPackages/GetProductPackageById.json"
}
},
"tags": [
"ContentProductPackages"
],
"description": "Gets a package by its identifier from the catalog.",
"operationId": "ProductPackage_Get",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/PackageIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/packageModel"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/2.0/types.json#/definitions/CloudError"
}
}
}
}
}
},
"definitions": {
"packageList": {
"description": "List available packages.",
"properties": {
"nextLink": {
"description": "URL to fetch the next set of packages.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Array of packages.",
"items": {
"$ref": "#/definitions/packageModel"
},
"type": "array"
}
},
"required": [
"value"
],
"type": "object"
},
"packageModel": {
visingla-ms marked this conversation as resolved.
Show resolved Hide resolved
"allOf": [
{
"$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag"
}
],
"description": "Represents a Package in Azure Security Insights.",
"properties": {
"properties": {
"description": "package properties",
"$ref": "#/definitions/packageProperties",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"packageProperties": {
"description": "Describes package properties",
"properties": {
"contentId": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId",
"description": "The content id of the package"
},
"contentKind": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataPackageKind",
"description": "The package kind"
},
"installedVersion": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion",
"description": "The version of the installed package, null or absent means not installed."
},
"contentSchemaVersion": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion",
"description": "The version of the content schema."
},
"resourceId": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId",
"description": "The metadata resource id."
},
"isNew": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag",
"description": "Flag indicates if this is a newly published package."
},
"isPreview": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag",
"description": "Flag indicates if this package is in preview."
},
"isFeatured": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag",
"description": "Flag indicates if this package is among the featured list."
},
"version": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion",
"description": "the latest version number of the package"
},
"displayName": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName",
"description": "The display name of the package"
},
"description": {
"description": "The description of the package",
"type": "string"
},
"publisherDisplayName": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName",
"description": "The publisher display name of the package"
},
"source": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataSource",
"description": "The source of the package"
},
"author": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataAuthor",
"description": "The author of the package"
},
"support": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataSupport",
"description": "The support tier of the package"
},
"dependencies": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies",
"description": "The support tier of the package"
},
"providers": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataProviders",
"description": "Providers for the package item"
},
"firstPublishDate": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataFirstPublishDate",
"description": "first publish date package item"
},
"lastPublishDate": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataLastPublishDate",
"description": "last publish date for the package item"
},
"categories": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataCategories",
"description": "The categories of the package"
},
"threatAnalysisTactics": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTactics",
"description": "the tactics the resource covers"
},
"threatAnalyticsTechniques": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTechniques",
"description": "the techniques the resource covers, these have to be aligned with the tactics being used"
},
"icon": {
"$ref": "./common/ContentCommonTypes.json#/definitions/metadataIcon",
"description": "the icon identifier. this id can later be fetched from the content metadata"
},
"packagedContent": {
"type": "object",
"description": "the json to deploy"
}
},
"required": [
"contentId",
"contentKind",
"version",
"displayName"
],
"type": "object"
}
},
"parameters": {
"PackageIdParameter": {
"description": "package Id",
"in": "path",
"name": "packageId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
}
}
Loading