@datafire/azure_automation_connection v5.0.0

@datafire/azure_automation_connection

Client library for AutomationManagement

Installation and Usage

npm install --save @datafire/azure_automation_connection

let azure_automation_connection = require('@datafire/azure_automation_connection').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

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

Description

Actions

Connection_ListByAutomationAccount

Retrieve a list of connections.

azure_automation_connection.Connection_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

• output ConnectionListResult

Connection_Delete

Delete the connection.

azure_automation_connection.Connection_Delete({
  "resourceGroupName": "",
  "automationAccountName": "",
  "connectionName": "",
  "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.
  • connectionName required string: The name of connection.
  • 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 Connection

Connection_Get

Retrieve the connection identified by connection name.

azure_automation_connection.Connection_Get({
  "resourceGroupName": "",
  "automationAccountName": "",
  "connectionName": "",
  "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.
  • connectionName required string: The name of connection.
  • 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 Connection

Connection_Update

Update a connection.

azure_automation_connection.Connection_Update({
  "resourceGroupName": "",
  "automationAccountName": "",
  "connectionName": "",
  "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.
  • connectionName required string: The parameters supplied to the update a connection operation.
  • parameters required ConnectionUpdateParameters
  • 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 Connection

Connection_CreateOrUpdate

Create or update a connection.

azure_automation_connection.Connection_CreateOrUpdate({
  "resourceGroupName": "",
  "automationAccountName": "",
  "connectionName": "",
  "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.
  • connectionName required string: The parameters supplied to the create or update connection operation.
  • parameters required ConnectionCreateOrUpdateParameters
  • 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 Connection

Definitions

Connection

• Connection object: Definition of the connection.
  • properties ConnectionProperties
  • id string: Fully qualified resource Id for the resource
  • name string: The name of the resource
  • type string: The type of the resource.

ConnectionCreateOrUpdateParameters

• ConnectionCreateOrUpdateParameters object: The parameters supplied to the create or update connection operation.
  • name required string: Gets or sets the name of the connection.
  • properties required ConnectionCreateOrUpdateProperties

ConnectionCreateOrUpdateProperties

• ConnectionCreateOrUpdateProperties object: The properties of the create connection properties
  • connectionType required ConnectionTypeAssociationProperty
  • description string: Gets or sets the description of the connection.
  • fieldDefinitionValues object: Gets or sets the field definition properties of the connection.

ConnectionListResult

• ConnectionListResult object: The response model for the list connection operation.
  • nextLink string: Gets or sets the next link.
  • value array: Gets or sets a list of connection.
    • items Connection

ConnectionProperties

• ConnectionProperties object: Definition of the connection properties.
  • connectionType ConnectionTypeAssociationProperty
  • creationTime string: Gets the creation time.
  • description string: Gets or sets the description.
  • fieldDefinitionValues object: Gets the field definition values of the connection.
  • lastModifiedTime string: Gets the last modified time.

ConnectionTypeAssociationProperty

• ConnectionTypeAssociationProperty object: The connection type property associated with the entity.
  • name string: Gets or sets the name of the connection type.

ConnectionUpdateParameters

• ConnectionUpdateParameters object: The parameters supplied to the update connection operation.
  • name string: Gets or sets the name of the connection.
  • properties ConnectionUpdateProperties

ConnectionUpdateProperties

• ConnectionUpdateProperties object: The properties of the update connection operation.
  • description string: Gets or sets the description of the connection.
  • fieldDefinitionValues object: Gets or sets the field definition values of the connection.