5.0.0 • Published 5 years ago

@datafire/azure_automation_account v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/azure_automation_account

Client library for AutomationManagement

Installation and Usage

npm install --save @datafire/azure_automation_account
let azure_automation_account = require('@datafire/azure_automation_account').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

Operations_List

Lists all of the available Automation REST API operations.

azure_automation_account.Operations_List({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string: Client Api Version.

Output

AutomationAccount_List

Retrieve a list of accounts within a given subscription.

azure_automation_account.AutomationAccount_List({
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

AutomationAccount_ListByResourceGroup

Retrieve a list of accounts within a given resource group.

azure_automation_account.AutomationAccount_ListByResourceGroup({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of an Azure Resource group.
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

AutomationAccount_Delete

Delete an automation account.

azure_automation_account.AutomationAccount_Delete({
  "resourceGroupName": "",
  "automationAccountName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of an Azure Resource group.
    • automationAccountName required string: The name of the automation account.
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

Output schema unknown

AutomationAccount_Get

Get information about an Automation Account.

azure_automation_account.AutomationAccount_Get({
  "resourceGroupName": "",
  "automationAccountName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of an Azure Resource group.
    • automationAccountName required string: The name of the automation account.
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

AutomationAccount_Update

Update an automation account.

azure_automation_account.AutomationAccount_Update({
  "resourceGroupName": "",
  "automationAccountName": "",
  "parameters": null,
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of an Azure Resource group.
    • automationAccountName required string: The name of the automation account.
    • parameters required AutomationAccountUpdateParameters
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

AutomationAccount_CreateOrUpdate

Create or update automation account.

azure_automation_account.AutomationAccount_CreateOrUpdate({
  "resourceGroupName": "",
  "automationAccountName": "",
  "parameters": null,
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of an Azure Resource group.
    • automationAccountName required string: The name of the automation account.
    • parameters required AutomationAccountCreateOrUpdateParameters
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

Keys_ListByAutomationAccount

Retrieve the automation keys for an account.

azure_automation_account.Keys_ListByAutomationAccount({
  "resourceGroupName": "",
  "automationAccountName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of an Azure Resource group.
    • automationAccountName required string: The name of the automation account.
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

Statistics_ListByAutomationAccount

Retrieve the statistics for the account.

azure_automation_account.Statistics_ListByAutomationAccount({
  "resourceGroupName": "",
  "automationAccountName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of an Azure Resource group.
    • automationAccountName required string: The name of the automation account.
    • $filter string: The filter to apply on the operation.
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

Usages_ListByAutomationAccount

Retrieve the usage for the account id.

azure_automation_account.Usages_ListByAutomationAccount({
  "resourceGroupName": "",
  "automationAccountName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of an Azure Resource group.
    • automationAccountName required string: The name of the automation account.
    • subscriptionId required string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • api-version required string: Client Api Version.

Output

Definitions

AutomationAccount

  • AutomationAccount object: Definition of the automation account type.
    • etag string: Gets or sets the etag of the resource.
    • properties AutomationAccountProperties
    • location string: The Azure Region where the resource lives
    • tags object: Resource tags.
    • id string: Fully qualified resource Id for the resource
    • name string: The name of the resource
    • type string: The type of the resource.

AutomationAccountCreateOrUpdateParameters

  • AutomationAccountCreateOrUpdateParameters object: The parameters supplied to the create or update automation account operation.
    • location string: Gets or sets the location of the resource.
    • name string: Gets or sets name of the resource.
    • properties AutomationAccountCreateOrUpdateProperties
    • tags object: Gets or sets the tags attached to the resource.

AutomationAccountCreateOrUpdateProperties

  • AutomationAccountCreateOrUpdateProperties object: The parameters supplied to the create or update account properties.

AutomationAccountListResult

  • AutomationAccountListResult object: The response model for the list account operation.
    • nextLink string: Gets or sets the next link.
    • value array: Gets or sets list of accounts.

AutomationAccountProperties

  • AutomationAccountProperties object: Definition of the account property.
    • creationTime string: Gets the creation time.
    • description string: Gets or sets the description.
    • lastModifiedBy string: Gets or sets the last modified by.
    • lastModifiedTime string: Gets the last modified time.
    • sku Sku
    • state string (values: Ok, Unavailable, Suspended): Gets status of account.

AutomationAccountUpdateParameters

  • AutomationAccountUpdateParameters object: The parameters supplied to the update automation account operation.
    • location string: Gets or sets the location of the resource.
    • name string: Gets or sets the name of the resource.
    • properties AutomationAccountUpdateProperties
    • tags object: Gets or sets the tags attached to the resource.

AutomationAccountUpdateProperties

  • AutomationAccountUpdateProperties object: The parameters supplied to the update account properties.

Key

  • Key object: Automation key which is used to register a DSC Node
    • KeyName string (values: Primary, Secondary): Automation key name.
    • Permissions string (values: Read, Full): Automation key permissions.
    • Value string: Value of the Automation Key used for registration.

KeyListResult

  • KeyListResult object
    • keys array: Lists the automation keys.

Operation

  • Operation object: Automation REST API operation
    • display object: Provider, Resource and Operation values
      • operation string: Operation type: Read, write, delete, etc.
      • provider string: Service provider: Microsoft.Automation
      • resource string: Resource on which the operation is performed: Runbooks, Jobs etc.
    • name string: Operation name: {provider}/{resource}/{operation}

OperationListResult

  • OperationListResult object: The response model for the list of Automation operations
    • value array: List of Automation operations supported by the Automation resource provider.

Sku

  • Sku object: The account SKU.
    • capacity integer: Gets or sets the SKU capacity.
    • family string: Gets or sets the SKU family.
    • name required string (values: Free, Basic): Gets or sets the SKU name of the account.

Statistics

  • Statistics object: Definition of the statistic.
    • counterProperty string: Gets the property value of the statistic.
    • counterValue integer: Gets the value of the statistic.
    • endTime string: Gets the endTime of the statistic.
    • id string: Gets the id.
    • startTime string: Gets the startTime of the statistic.

StatisticsListResult

  • StatisticsListResult object: The response model for the list statistics operation.
    • value array: Gets or sets a list of statistics.

Usage

  • Usage object: Definition of Usage.
    • currentValue number: Gets or sets the current usage value.
    • id string: Gets or sets the id of the resource.
    • limit integer: Gets or sets max limit. -1 for unlimited
    • name UsageCounterName
    • throttleStatus string: Gets or sets the throttle status.
    • unit string: Gets or sets the usage unit name.

UsageCounterName

  • UsageCounterName object: Definition of usage counter name.
    • localizedValue string: Gets or sets the localized usage counter name.
    • value string: Gets or sets the usage counter name.

UsageListResult

  • UsageListResult object: The response model for the get usage operation.
    • value array: Gets or sets usage.
datafire
@infinitebrahmanuniverse/nolb-_datafire_az@everything-registry/sub-chunk-220
5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago