3.0.0 • Published 5 years ago
@datafire/azure_applicationinsights_workbooktemplates_api v3.0.0
@datafire/azure_applicationinsights_workbooktemplates_api
Client library for ApplicationInsightsManagementClient
Installation and Usage
npm install --save @datafire/azure_applicationinsights_workbooktemplates_api
let azure_applicationinsights_workbooktemplates_api = require('@datafire/azure_applicationinsights_workbooktemplates_api').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Azure Application Insights workbook template type.
Actions
WorkbookTemplates_ListByResourceGroup
Get all Workbook templates defined within a specified resource group.
azure_applicationinsights_workbooktemplates_api.WorkbookTemplates_ListByResourceGroup({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The ID of the target subscription. - resourceGroupName required
string
: The name of the resource group. The name is case insensitive. - api-version required
string
: The API version to use for this operation.
- subscriptionId required
Output
- output WorkbookTemplatesListResult
WorkbookTemplates_Delete
Delete a workbook template.
azure_applicationinsights_workbooktemplates_api.WorkbookTemplates_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The ID of the target subscription. - resourceGroupName required
string
: The name of the resource group. The name is case insensitive. - resourceName required
string
: The name of the Application Insights component resource. - api-version required
string
: The API version to use for this operation.
- subscriptionId required
Output
Output schema unknown
WorkbookTemplates_Get
Get a single workbook template by its resourceName.
azure_applicationinsights_workbooktemplates_api.WorkbookTemplates_Get({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The ID of the target subscription. - resourceGroupName required
string
: The name of the resource group. The name is case insensitive. - resourceName required
string
: The name of the Application Insights component resource. - api-version required
string
: The API version to use for this operation.
- subscriptionId required
Output
- output WorkbookTemplate
WorkbookTemplates_Update
Updates a workbook template that has already been added.
azure_applicationinsights_workbooktemplates_api.WorkbookTemplates_Update({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The ID of the target subscription. - resourceGroupName required
string
: The name of the resource group. The name is case insensitive. - resourceName required
string
: The name of the Application Insights component resource. - api-version required
string
: The API version to use for this operation. - WorkbookTemplateUpdateParameters WorkbookTemplateUpdateParameters
- subscriptionId required
Output
- output WorkbookTemplate
WorkbookTemplates_CreateOrUpdate
Create a new workbook template.
azure_applicationinsights_workbooktemplates_api.WorkbookTemplates_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": "",
"workbookTemplateProperties": null
}, context)
Input
- input
object
- subscriptionId required
string
: The ID of the target subscription. - resourceGroupName required
string
: The name of the resource group. The name is case insensitive. - resourceName required
string
: The name of the Application Insights component resource. - api-version required
string
: The API version to use for this operation. - workbookTemplateProperties required WorkbookTemplate
- subscriptionId required
Output
- output WorkbookTemplate
Definitions
ErrorFieldContract
- ErrorFieldContract
object
: Error Field contract.- code
string
: Property level error code. - message
string
: Human-readable representation of property-level error. - target
string
: Property name.
- code
WorkbookError
- WorkbookError
object
: Error message body that will indicate why the operation failed.- code
string
: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - details
array
: The list of invalid fields send in request, in case of validation error.- items ErrorFieldContract
- message
string
: Human-readable representation of the error.
- code
WorkbookTemplate
- WorkbookTemplate
object
: An Application Insights workbook template definition.- properties WorkbookTemplateProperties
- id
string
: Azure resource Id - location required
string
: Resource location - name
string
: Azure resource name. - tags
object
: Resource tags - type
string
: Azure resource type
WorkbookTemplateGallery
- WorkbookTemplateGallery
object
: Gallery information for a workbook template.- category
string
: Category for the gallery. - name
string
: Name of the workbook template in the gallery. - order
integer
: Order of the template within the gallery. - resourceType
string
: Azure resource type supported by the gallery. - type
string
: Type of workbook supported by the workbook template.
- category
WorkbookTemplateLocalizedGallery
- WorkbookTemplateLocalizedGallery
object
: Localized template data and gallery information.- galleries
array
: Workbook galleries supported by the template.- items WorkbookTemplateGallery
- templateData
object
: Valid JSON object containing workbook template payload.
- galleries
WorkbookTemplateProperties
- WorkbookTemplateProperties
object
: Properties that contain a workbook template.- author
string
: Information about the author of the workbook template. - galleries required
array
: Workbook galleries supported by the template.- items WorkbookTemplateGallery
- localized
object
: Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal. - priority
integer
: Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. - templateData required
object
: Valid JSON object containing workbook template payload.
- author
WorkbookTemplateResource
- WorkbookTemplateResource
object
: An azure resource object- id
string
: Azure resource Id - location required
string
: Resource location - name
string
: Azure resource name. - tags
object
: Resource tags - type
string
: Azure resource type
- id
WorkbookTemplateUpdateParameters
- WorkbookTemplateUpdateParameters
object
: The parameters that can be provided when updating workbook template.- properties WorkbookTemplateProperties
- tags
object
: Resource tags
WorkbookTemplatesListResult
- WorkbookTemplatesListResult
object
: WorkbookTemplate list result.- value
array
: An array of workbook templates.- items WorkbookTemplate
- value
3.0.0
5 years ago