@datafire/azure_maintenance_maintenance v3.0.0
@datafire/azure_maintenance_maintenance
Client library for MaintenanceManagementClient
Installation and Usage
npm install --save @datafire/azure_maintenance_maintenance
let azure_maintenance_maintenance = require('@datafire/azure_maintenance_maintenance').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Azure Maintenance Management Client
Actions
Operations_List
List the available operations supported by the Microsoft.Maintenance resource provider
azure_maintenance_maintenance.Operations_List({
"api-version": ""
}, context)
Input
- input
object
- api-version required
string
: Version of the API to be used with the client request.
- api-version required
Output
- output OperationsListResult
MaintenanceConfigurations_List
Get Configuration records within a subscription
azure_maintenance_maintenance.MaintenanceConfigurations_List({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
MaintenanceConfigurations_Delete
Delete Configuration record
azure_maintenance_maintenance.MaintenanceConfigurations_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource Group Name - resourceName required
string
: Resource Identifier - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output MaintenanceConfiguration
MaintenanceConfigurations_Get
Get Configuration record
azure_maintenance_maintenance.MaintenanceConfigurations_Get({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource Group Name - resourceName required
string
: Resource Identifier - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output MaintenanceConfiguration
MaintenanceConfigurations_Update
Patch configuration record
azure_maintenance_maintenance.MaintenanceConfigurations_Update({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"configuration": {},
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource Group Name - resourceName required
string
: Resource Identifier - configuration required MaintenanceConfiguration
- api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output MaintenanceConfiguration
MaintenanceConfigurations_CreateOrUpdate
Create or Update configuration record
azure_maintenance_maintenance.MaintenanceConfigurations_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"configuration": {},
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource Group Name - resourceName required
string
: Resource Identifier - configuration required MaintenanceConfiguration
- api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output MaintenanceConfiguration
ApplyUpdates_CreateOrUpdateParent
Apply maintenance updates to resource with parent
azure_maintenance_maintenance.ApplyUpdates_CreateOrUpdateParent({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceParentType": "",
"resourceParentName": "",
"resourceType": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceParentType required
string
: Resource parent type - resourceParentName required
string
: Resource parent identifier - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ApplyUpdate
ApplyUpdates_GetParent
Track maintenance updates to resource with parent
azure_maintenance_maintenance.ApplyUpdates_GetParent({
"subscriptionId": "",
"resourceGroupName": "",
"resourceParentType": "",
"resourceParentName": "",
"providerName": "",
"resourceType": "",
"resourceName": "",
"applyUpdateName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - resourceParentType required
string
: Resource parent type - resourceParentName required
string
: Resource parent identifier - providerName required
string
: Resource provider name - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - applyUpdateName required
string
: applyUpdate Id - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ApplyUpdate
ConfigurationAssignments_ListParent
List configurationAssignments for resource.
azure_maintenance_maintenance.ConfigurationAssignments_ListParent({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceParentType": "",
"resourceParentName": "",
"resourceType": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceParentType required
string
: Resource parent type - resourceParentName required
string
: Resource parent identifier - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
ConfigurationAssignments_DeleteParent
Unregister configuration for resource.
azure_maintenance_maintenance.ConfigurationAssignments_DeleteParent({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceParentType": "",
"resourceParentName": "",
"resourceType": "",
"resourceName": "",
"configurationAssignmentName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceParentType required
string
: Resource parent type - resourceParentName required
string
: Resource parent identifier - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - configurationAssignmentName required
string
: Unique configuration assignment name - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ConfigurationAssignment
ConfigurationAssignments_CreateOrUpdateParent
Register configuration for resource.
azure_maintenance_maintenance.ConfigurationAssignments_CreateOrUpdateParent({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceParentType": "",
"resourceParentName": "",
"resourceType": "",
"resourceName": "",
"configurationAssignmentName": "",
"configurationAssignment": {},
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceParentType required
string
: Resource parent type - resourceParentName required
string
: Resource parent identifier - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - configurationAssignmentName required
string
: Configuration assignment name - configurationAssignment required ConfigurationAssignment
- api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ConfigurationAssignment
Updates_ListParent
Get updates to resources.
azure_maintenance_maintenance.Updates_ListParent({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceParentType": "",
"resourceParentName": "",
"resourceType": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceParentType required
string
: Resource parent type - resourceParentName required
string
: Resource parent identifier - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ListUpdatesResult
ApplyUpdates_CreateOrUpdate
Apply maintenance updates to resource
azure_maintenance_maintenance.ApplyUpdates_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceType": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ApplyUpdate
ApplyUpdates_Get
Track maintenance updates to resource
azure_maintenance_maintenance.ApplyUpdates_Get({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceType": "",
"resourceName": "",
"applyUpdateName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - applyUpdateName required
string
: applyUpdate Id - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ApplyUpdate
ConfigurationAssignments_List
List configurationAssignments for resource.
azure_maintenance_maintenance.ConfigurationAssignments_List({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceType": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
ConfigurationAssignments_Delete
Unregister configuration for resource.
azure_maintenance_maintenance.ConfigurationAssignments_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceType": "",
"resourceName": "",
"configurationAssignmentName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - configurationAssignmentName required
string
: Unique configuration assignment name - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ConfigurationAssignment
ConfigurationAssignments_CreateOrUpdate
Register configuration for resource.
azure_maintenance_maintenance.ConfigurationAssignments_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceType": "",
"resourceName": "",
"configurationAssignmentName": "",
"configurationAssignment": {},
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - configurationAssignmentName required
string
: Configuration assignment name - configurationAssignment required ConfigurationAssignment
- api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ConfigurationAssignment
Updates_List
Get updates to resources.
azure_maintenance_maintenance.Updates_List({
"subscriptionId": "",
"resourceGroupName": "",
"providerName": "",
"resourceType": "",
"resourceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - resourceGroupName required
string
: Resource group name - providerName required
string
: Resource provider name - resourceType required
string
: Resource type - resourceName required
string
: Resource identifier - api-version required
string
: Version of the API to be used with the client request.
- subscriptionId required
Output
- output ListUpdatesResult
Definitions
ApplyUpdate
- ApplyUpdate
object
: Apply Update request- properties ApplyUpdateProperties
- id
string
: Fully qualified identifier of the resource - name
string
: Name of the resource - type
string
: Type of the resource
ApplyUpdateProperties
- ApplyUpdateProperties
object
: Properties for apply update- lastUpdateTime
string
: Last Update time - resourceId
string
: The resourceId - status
string
(values: Pending, InProgress, Completed, RetryNow, RetryLater): The status
- lastUpdateTime
ConfigurationAssignment
- ConfigurationAssignment
object
: Configuration Assignment- location
string
: Location of the resource - properties ConfigurationAssignmentProperties
- id
string
: Fully qualified identifier of the resource - name
string
: Name of the resource - type
string
: Type of the resource
- location
ConfigurationAssignmentProperties
- ConfigurationAssignmentProperties
object
: Properties for configuration assignment- maintenanceConfigurationId
string
: The maintenance configuration Id - resourceId
string
: The unique resourceId
- maintenanceConfigurationId
ErrorDetails
- ErrorDetails
object
: An error response details received from the Azure Maintenance service.- code
string
: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - message
string
: Human-readable representation of the error.
- code
ListConfigurationAssignmentsResult
- ListConfigurationAssignmentsResult
object
: Response for ConfigurationAssignments list- value
array
: The list of configuration Assignments- items ConfigurationAssignment
- value
ListMaintenanceConfigurationsResult
- ListMaintenanceConfigurationsResult
object
: Response for MaintenanceConfigurations list- value
array
: The list of maintenance Configurations- items MaintenanceConfiguration
- value
ListUpdatesResult
- ListUpdatesResult
object
: Response for Updates list- value
array
: The pending updates- items Update
- value
MaintenanceConfiguration
- MaintenanceConfiguration
object
: Maintenance configuration record type- location
string
: Gets or sets location of the resource - properties MaintenanceConfigurationProperties
- tags
object
: Gets or sets tags of the resource - id
string
: Fully qualified identifier of the resource - name
string
: Name of the resource - type
string
: Type of the resource
- location
MaintenanceConfigurationProperties
- MaintenanceConfigurationProperties
object
: Properties for maintenance configuration- extensionProperties
object
: Gets or sets extensionProperties of the maintenanceConfiguration - maintenanceScope
string
(values: All, Host, Resource, InResource): Gets or sets maintenanceScope of the configuration - namespace
string
: Gets or sets namespace of the resource
- extensionProperties
MaintenanceError
- MaintenanceError
object
: An error response received from the Azure Maintenance service.- error ErrorDetails
Operation
- Operation
object
: Represents an operation returned by the GetOperations request- display OperationInfo
- name
string
: Name of the operation - origin
string
: Origin of the operation - properties
object
: Properties of the operation
OperationInfo
- OperationInfo
object
: Information about an operation- description
string
: Description of the operation - operation
string
: Name of the operation - provider
string
: Name of the provider - resource
string
: Name of the resource type
- description
OperationsListResult
- OperationsListResult
object
: Result of the List Operations operation- value
array
: A collection of operations- items Operation
- value
Resource
- Resource
object
: Definition of a Resource- id
string
: Fully qualified identifier of the resource - name
string
: Name of the resource - type
string
: Type of the resource
- id
Update
- Update
object
: Maintenance update on a resource- impactDurationInSec
integer
: Duration of impact in seconds - impactType
string
(values: None, Freeze, Restart, Redeploy): The impact type - maintenanceScope
string
(values: All, Host, Resource, InResource): The impact area - notBefore
string
: Time when Azure will start force updates if not self-updated by customer before this time - properties UpdateProperties
- status
string
(values: Pending, InProgress, Completed, RetryNow, RetryLater): The status
- impactDurationInSec
UpdateProperties
- UpdateProperties
object
: Properties for update- resourceId
string
: The resourceId
- resourceId
5 years ago