3.0.0 • Published 5 years ago
@datafire/azure_portal v3.0.0
@datafire/azure_portal
Client library for portal
Installation and Usage
npm install --save @datafire/azure_portal
let azure_portal = require('@datafire/azure_portal').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Allows creation and deletion of Azure Shared Dashboards.
Actions
Operations_List
The Microsoft Portal operations API.
azure_portal.Operations_List({
"api-version": ""
}, context)
Input
- input
object
- api-version required
string
: The API version to be used with the HTTP request.
- api-version required
Output
Dashboards_ListBySubscription
Gets all the dashboards within a subscription.
azure_portal.Dashboards_ListBySubscription({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) - api-version required
string
: The API version to be used with the HTTP request.
- subscriptionId required
Output
- output DashboardListResult
Dashboards_ListByResourceGroup
Gets all the Dashboards within a resource group.
azure_portal.Dashboards_ListByResourceGroup({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) - resourceGroupName required
string
: The name of the resource group. - api-version required
string
: The API version to be used with the HTTP request.
- subscriptionId required
Output
- output DashboardListResult
Dashboards_Delete
Deletes the Dashboard.
azure_portal.Dashboards_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"dashboardName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) - resourceGroupName required
string
: The name of the resource group. - dashboardName required
string
: The name of the dashboard. - api-version required
string
: The API version to be used with the HTTP request.
- subscriptionId required
Output
Output schema unknown
Dashboards_Get
Gets the Dashboard.
azure_portal.Dashboards_Get({
"subscriptionId": "",
"resourceGroupName": "",
"dashboardName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) - resourceGroupName required
string
: The name of the resource group. - dashboardName required
string
: The name of the dashboard. - api-version required
string
: The API version to be used with the HTTP request.
- subscriptionId required
Output
- output Dashboard
Dashboards_Update
Updates an existing Dashboard.
azure_portal.Dashboards_Update({
"subscriptionId": "",
"resourceGroupName": "",
"dashboardName": "",
"api-version": "",
"dashboard": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) - resourceGroupName required
string
: The name of the resource group. - dashboardName required
string
: The name of the dashboard. - api-version required
string
: The API version to be used with the HTTP request. - dashboard required PatchableDashboard
- subscriptionId required
Output
- output Dashboard
Dashboards_CreateOrUpdate
Creates or updates a Dashboard.
azure_portal.Dashboards_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"dashboardName": "",
"api-version": "",
"dashboard": {
"location": ""
}
}, context)
Input
- input
object
- subscriptionId required
string
: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) - resourceGroupName required
string
: The name of the resource group. - dashboardName required
string
: The name of the dashboard. - api-version required
string
: The API version to be used with the HTTP request. - dashboard required Dashboard
- subscriptionId required
Output
- output Dashboard
Definitions
Dashboard
- Dashboard
object
: The shared dashboard resource definition.- id
string
: Resource Id - location required
string
: Resource location - name
string
: Resource name - properties DashboardProperties
- tags
object
: Resource tags - type
string
: Resource type
- id
DashboardLens
- DashboardLens
object
: A dashboard lens.- metadata
object
: The dashboard len's metadata. - order required
integer
: The lens order. - parts required
object
: The dashboard parts.
- metadata
DashboardListResult
- DashboardListResult
object
: List of dashboards.- nextLink
string
: The URL to use for getting the next set of results. - value
array
: The array of custom resource provider manifests.- items Dashboard
- nextLink
DashboardParts
- DashboardParts
object
: A dashboard part.- metadata
object
: The dashboard part's metadata. - position required
object
: The dashboard's part position.- colSpan required
number
: The dashboard's part column span. - metadata
object
: The dashboard part's metadata. - rowSpan required
number
: The dashboard's part row span. - x required
number
: The dashboard's part x coordinate. - y required
number
: The dashboard's part y coordinate.
- colSpan required
- metadata
DashboardProperties
- DashboardProperties
object
: The shared dashboard properties.- lenses
object
: The dashboard lenses. - metadata
object
: The dashboard metadata.
- lenses
ErrorDefinition
- ErrorDefinition
object
: Error definition.- code
string
: Service specific error code which serves as the substatus for the HTTP error code. - details
array
: Internal error details.- items ErrorDefinition
- message
string
: Description of the error.
- code
ErrorResponse
- ErrorResponse
object
: Error response.- error ErrorDefinition
PatchableDashboard
- PatchableDashboard
object
: The shared dashboard resource definition.- properties DashboardProperties
- tags
object
: Resource tags
ResourceProviderOperation
- ResourceProviderOperation
object
: Supported operations of this resource provider.- display
object
: Display metadata associated with the operation.- description
string
: Description of this operation. - operation
string
: Type of operation: get, read, delete, etc. - provider
string
: Resource provider: Microsoft Custom Providers. - resource
string
: Resource on which the operation is performed.
- description
- isDataAction
string
: Indicates whether the operation applies to data-plane. - name
string
: Operation name, in format of {provider}/{resource}/{operation}
- display
ResourceProviderOperationList
- ResourceProviderOperationList
object
: Results of the request to list operations.- nextLink
string
: The URL to use for getting the next set of results. - value
array
: List of operations supported by this resource provider.
- nextLink
3.0.0
5 years ago