3.0.0 • Published 5 years ago

@datafire/azure_automation_python2package v3.0.0

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

@datafire/azure_automation_python2package

Client library for AutomationManagement

Installation and Usage

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

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

Description

Actions

Python2Package_ListByAutomationAccount

Retrieve a list of python 2 packages.

azure_automation_python2package.Python2Package_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

Python2Package_Delete

Delete the python 2 package by name.

azure_automation_python2package.Python2Package_Delete({
  "resourceGroupName": "",
  "automationAccountName": "",
  "packageName": "",
  "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.
    • packageName required string: The python package name.
    • 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

Python2Package_Get

Retrieve the python 2 package identified by package name.

azure_automation_python2package.Python2Package_Get({
  "resourceGroupName": "",
  "automationAccountName": "",
  "packageName": "",
  "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.
    • packageName required string: The python package name.
    • 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

Python2Package_Update

Update the python 2 package identified by package name.

azure_automation_python2package.Python2Package_Update({
  "resourceGroupName": "",
  "automationAccountName": "",
  "packageName": "",
  "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.
    • packageName required string: The name of python package.
    • parameters required PythonPackageUpdateParameters
    • 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

Python2Package_CreateOrUpdate

Create or Update the python 2 package identified by package name.

azure_automation_python2package.Python2Package_CreateOrUpdate({
  "resourceGroupName": "",
  "automationAccountName": "",
  "packageName": "",
  "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.
    • packageName required string: The name of python package.
    • parameters required PythonPackageCreateParameters
    • 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

Activity

  • Activity object: Definition of the activity.
    • id string: Gets or sets the id of the resource.
    • name string: Gets the name of the activity.
    • properties ActivityProperties

ActivityListResult

  • ActivityListResult object: The response model for the list activity operation.
    • nextLink string: Gets or sets the next link.
    • value array: Gets or sets a list of activities.

ActivityOutputType

  • ActivityOutputType object: Definition of the activity output type.
    • name string: Gets or sets the name of the activity output type.
    • type string: Gets or sets the type of the activity output type.

ActivityParameter

  • ActivityParameter object: Definition of the activity parameter.
    • description string: Gets or sets the description of the activity parameter.
    • isDynamic boolean: Gets or sets a Boolean value that indicates true if the parameter is dynamic.
    • isMandatory boolean: Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.
    • name string: Gets or sets the name of the activity parameter.
    • position integer: Gets or sets the position of the activity parameter.
    • type string: Gets or sets the type of the activity parameter.
    • validationSet array: Gets or sets the validation set of activity parameter.
    • valueFromPipeline boolean: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.
    • valueFromPipelineByPropertyName boolean: Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.
    • valueFromRemainingArguments boolean: Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.

ActivityParameterSet

  • ActivityParameterSet object: Definition of the activity parameter set.
    • name string: Gets or sets the name of the activity parameter set.
    • parameters array: Gets or sets the parameters of the activity parameter set.

ActivityParameterValidationSet

  • ActivityParameterValidationSet object: Definition of the activity parameter validation set.
    • memberValue string: Gets or sets the name of the activity parameter validation set member.

ActivityProperties

  • ActivityProperties object: Properties of the activity.
    • creationTime string: Gets or sets the creation time.
    • definition string: Gets or sets the user name of the activity.
    • description string: Gets or sets the description.
    • lastModifiedTime string: Gets or sets the last modified time.
    • outputTypes array: Gets or sets the output types of the activity.
    • parameterSets array: Gets or sets the parameter sets of the activity.

ContentHash

  • ContentHash object: Definition of the runbook property type.
    • algorithm required string: Gets or sets the content hash algorithm used to hash the content.
    • value required string: Gets or sets expected hash value of the content.

ContentLink

  • ContentLink object: Definition of the content link.
    • contentHash ContentHash
    • uri string: Gets or sets the uri of the runbook content.
    • version string: Gets or sets the version of the content.

Module

  • Module object: Definition of the module type.
    • etag string: Gets or sets the etag of the resource.
    • properties ModuleProperties
    • 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.

ModuleErrorInfo

  • ModuleErrorInfo object: Definition of the module error info type.
    • code string: Gets or sets the error code.
    • message string: Gets or sets the error message.

ModuleListResult

  • ModuleListResult object: The response model for the list module operation.
    • nextLink string: Gets or sets the next link.
    • value array: Gets or sets a list of modules.

ModuleProperties

  • ModuleProperties object: Definition of the module property type.
    • activityCount integer: Gets or sets the activity count of the module.
    • contentLink ContentLink
    • creationTime string: Gets or sets the creation time.
    • description string: Gets or sets the description.
    • error ModuleErrorInfo
    • isComposite boolean: Gets or sets type of module, if its composite or not.
    • isGlobal boolean: Gets or sets the isGlobal flag of the module.
    • lastModifiedTime string: Gets or sets the last modified time.
    • provisioningState string (values: Created, Creating, StartingImportModuleRunbook, RunningImportModuleRunbook, ContentRetrieved, ContentDownloaded, ContentValidated, ConnectionTypeImported, ContentStored, ModuleDataStored, ActivitiesStored, ModuleImportRunbookComplete, Succeeded, Failed, Cancelled, Updating): Gets or sets the provisioning state of the module.
    • sizeInBytes integer: Gets or sets the size in bytes of the module.
    • version string: Gets or sets the version of the module.

PythonPackageCreateParameters

  • PythonPackageCreateParameters object: The parameters supplied to the create or update module operation.

PythonPackageCreateProperties

  • PythonPackageCreateProperties object: The parameters supplied to the create or update module properties.

PythonPackageUpdateParameters

  • PythonPackageUpdateParameters object: The parameters supplied to the update module operation.
    • tags object: Gets or sets the tags attached to the resource.

TypeField

  • TypeField object: Information about a field of a type.
    • name string: Gets or sets the name of the field.
    • type string: Gets or sets the type of the field.

TypeFieldListResult

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