{"analyzedAt":"2022-07-14T03:35:17.424Z","collected":{"metadata":{"name":"@datafire/azure_hanaonazure","scope":"datafire","version":"4.0.0","description":"DataFire integration for HanaManagementClient","date":"2020-12-21T19:00:40.003Z","author":{"name":"DataFire"},"publisher":{"username":"datafire","email":"bobby@datafire.io"},"maintainers":[{"username":"datafire","email":"bobby@datafire.io"}],"repository":{"type":"git","url":"git+https://github.com/DataFire/integrations.git"},"links":{"npm":"https://www.npmjs.com/package/%40datafire%2Fazure_hanaonazure","homepage":"https://github.com/DataFire/integrations#readme","repository":"https://github.com/DataFire/integrations","bugs":"https://github.com/DataFire/integrations/issues"},"license":"MIT","dependencies":{"datafire":"^2.0.0"},"peerDependencies":{"datafire":"^2.0.0"},"releases":[{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":1},{"from":"2020-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":2}],"readme":"# @datafire/azure_hanaonazure\n\nClient library for HanaManagementClient\n\n## Installation and Usage\n```bash\nnpm install --save @datafire/azure_hanaonazure\n```\n```js\nlet azure_hanaonazure = require('@datafire/azure_hanaonazure').create({\n  access_token: \"\",\n  refresh_token: \"\",\n  client_id: \"\",\n  client_secret: \"\",\n  redirect_uri: \"\"\n});\n\n.then(data => {\n  console.log(data);\n});\n```\n\n## Description\n\nThe SAP HANA on Azure Management Client.\n\n## Actions\n\n### Operations_List\nGets a list of SAP HANA management operations.\n\n\n```js\nazure_hanaonazure.Operations_List({\n  \"api-version\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n\n#### Output\n* output [OperationList](#operationlist)\n\n### HanaInstances_List\nGets a list of SAP HANA instances in the specified subscription. The operations returns various properties of each SAP HANA on Azure instance.\n\n\n```js\nazure_hanaonazure.HanaInstances_List({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n\n#### Output\n* output [HanaInstancesListResult](#hanainstanceslistresult)\n\n### SapMonitors_List\nGets a list of SAP monitors in the specified subscription. The operations returns various properties of each SAP monitor.\n\n\n```js\nazure_hanaonazure.SapMonitors_List({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n\n#### Output\n* output [SapMonitorListResult](#sapmonitorlistresult)\n\n### HanaInstances_ListByResourceGroup\nGets a list of SAP HANA instances in the specified subscription and the resource group. The operations returns various properties of each SAP HANA on Azure instance.\n\n\n```js\nazure_hanaonazure.HanaInstances_ListByResourceGroup({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n\n#### Output\n* output [HanaInstancesListResult](#hanainstanceslistresult)\n\n### HanaInstances_Delete\nDeletes a SAP HANA instance with the specified subscription, resource group, and instance name.\n\n\n```js\nazure_hanaonazure.HanaInstances_Delete({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"hanaInstanceName\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * hanaInstanceName **required** `string`: Name of the SAP HANA on Azure instance.\n\n#### Output\n*Output schema unknown*\n\n### HanaInstances_Get\nGets properties of a SAP HANA instance for the specified subscription, resource group, and instance name.\n\n\n```js\nazure_hanaonazure.HanaInstances_Get({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"hanaInstanceName\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * hanaInstanceName **required** `string`: Name of the SAP HANA on Azure instance.\n\n#### Output\n* output [HanaInstance](#hanainstance)\n\n### HanaInstances_Update\nPatches the Tags field of a SAP HANA instance for the specified subscription, resource group, and instance name.\n\n\n```js\nazure_hanaonazure.HanaInstances_Update({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"hanaInstanceName\": \"\",\n  \"tagsParameter\": {}\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * hanaInstanceName **required** `string`: Name of the SAP HANA on Azure instance.\n  * tagsParameter **required** [Tags](#tags)\n\n#### Output\n* output [HanaInstance](#hanainstance)\n\n### HanaInstances_Create\nCreates a SAP HANA instance for the specified subscription, resource group, and instance name.\n\n\n```js\nazure_hanaonazure.HanaInstances_Create({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"hanaInstanceName\": \"\",\n  \"hanaInstanceParameter\": null\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * hanaInstanceName **required** `string`: Name of the SAP HANA on Azure instance.\n  * hanaInstanceParameter **required** [HanaInstance](#hanainstance)\n\n#### Output\n* output [HanaInstance](#hanainstance)\n\n### HanaInstances_Restart\nThe operation to restart a SAP HANA instance.\n\n\n```js\nazure_hanaonazure.HanaInstances_Restart({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"hanaInstanceName\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * hanaInstanceName **required** `string`: Name of the SAP HANA on Azure instance.\n\n#### Output\n*Output schema unknown*\n\n### HanaInstances_Shutdown\nThe operation to shutdown a SAP HANA instance.\n\n\n```js\nazure_hanaonazure.HanaInstances_Shutdown({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"hanaInstanceName\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * hanaInstanceName **required** `string`: Name of the SAP HANA on Azure instance.\n\n#### Output\n*Output schema unknown*\n\n### HanaInstances_Start\nThe operation to start a SAP HANA instance.\n\n\n```js\nazure_hanaonazure.HanaInstances_Start({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"hanaInstanceName\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * hanaInstanceName **required** `string`: Name of the SAP HANA on Azure instance.\n\n#### Output\n*Output schema unknown*\n\n### SapMonitors_Delete\nDeletes a SAP monitor with the specified subscription, resource group, and monitor name.\n\n\n```js\nazure_hanaonazure.SapMonitors_Delete({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"sapMonitorName\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * sapMonitorName **required** `string`: Name of the SAP monitor resource.\n\n#### Output\n*Output schema unknown*\n\n### SapMonitors_Get\nGets properties of a SAP monitor for the specified subscription, resource group, and resource name.\n\n\n```js\nazure_hanaonazure.SapMonitors_Get({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"sapMonitorName\": \"\"\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * sapMonitorName **required** `string`: Name of the SAP monitor resource.\n\n#### Output\n* output [SapMonitor](#sapmonitor)\n\n### SapMonitors_Update\nPatches the Tags field of a SAP monitor for the specified subscription, resource group, and monitor name.\n\n\n```js\nazure_hanaonazure.SapMonitors_Update({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"sapMonitorName\": \"\",\n  \"tagsParameter\": {}\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * sapMonitorName **required** `string`: Name of the SAP monitor resource.\n  * tagsParameter **required** [Tags](#tags)\n\n#### Output\n* output [SapMonitor](#sapmonitor)\n\n### SapMonitors_Create\nCreates a SAP monitor for the specified subscription, resource group, and resource name.\n\n\n```js\nazure_hanaonazure.SapMonitors_Create({\n  \"api-version\": \"\",\n  \"subscriptionId\": \"\",\n  \"resourceGroupName\": \"\",\n  \"sapMonitorName\": \"\",\n  \"sapMonitorParameter\": null\n}, context)\n```\n\n#### Input\n* input `object`\n  * api-version **required** `string`: Client API version.\n  * subscriptionId **required** `string`: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.\n  * resourceGroupName **required** `string`: Name of the resource group.\n  * sapMonitorName **required** `string`: Name of the SAP monitor resource.\n  * sapMonitorParameter **required** [SapMonitor](#sapmonitor)\n\n#### Output\n* output [SapMonitor](#sapmonitor)\n\n\n\n## Definitions\n\n### Disk\n* Disk `object`: Specifies the disk information fo the HANA instance\n  * diskSizeGB `integer`: Specifies the size of an empty data disk in gigabytes.\n  * lun `integer`: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.\n  * name `string`: The disk name.\n\n### Display\n* Display `object`: Detailed HANA operation information\n  * description `string`: The localized friendly description for the operation as shown to the user. This description should be thorough, yet concise. It will be used in tool-tips and detailed views.\n  * operation `string`: The localized friendly name for the operation as shown to the user. This name should be concise (to fit in drop downs), but clear (self-documenting). Use Title Casing and include the entity/resource to which it applies.\n  * origin `string`: The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is 'user,system'\n  * provider `string`: The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with \"Microsoft\" for 1st party services.\n  * resource `string`: The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the “name” section.\n\n### ErrorResponse\n* ErrorResponse `object`: Describes the format of Error response.\n  * code `string`: Error code\n  * message `string`: Error message indicating why the operation failed.\n\n### HanaInstance\n* HanaInstance `object`: HANA instance info on Azure (ARM properties and HANA properties)\n  * properties [HanaInstanceProperties](#hanainstanceproperties)\n  * id `string`: Resource ID\n  * location `string`: Resource location\n  * name `string`: Resource name\n  * tags `object`: Resource tags\n  * type `string`: Resource type\n\n### HanaInstanceProperties\n* HanaInstanceProperties `object`: Describes the properties of a HANA instance.\n  * hanaInstanceId `string`: Specifies the HANA instance unique ID.\n  * hardwareProfile [HardwareProfile](#hardwareprofile)\n  * hwRevision `string`: Hardware revision of a HANA instance\n  * networkProfile [NetworkProfile](#networkprofile)\n  * osProfile [OSProfile](#osprofile)\n  * partnerNodeId `string`: ARM ID of another HanaInstance that will share a network with this HanaInstance\n  * powerState `string` (values: starting, started, stopping, stopped, restarting, unknown): Resource power state\n  * provisioningState `string` (values: Accepted, Creating, Updating, Failed, Succeeded, Deleting, Migrating): State of provisioning of the HanaInstance\n  * proximityPlacementGroup `string`: Resource proximity placement group\n  * storageProfile [StorageProfile](#storageprofile)\n\n### HanaInstancesListResult\n* HanaInstancesListResult `object`: The response from the List HANA Instances operation.\n  * nextLink `string`: The URL to get the next set of HANA instances.\n  * value `array`: The list of SAP HANA on Azure instances.\n    * items [HanaInstance](#hanainstance)\n\n### HardwareProfile\n* HardwareProfile `object`: Specifies the hardware settings for the HANA instance.\n  * hanaInstanceSize `string` (values: S72m, S144m, S72, S144, S192, S192m, S192xm, S96, S112, S224m, S224o, S224om, S224oo, S224oom, S224ooo, S224oxm, S224oxxm, S384, S384m, S384xm, S384xxm, S576m, S576xm, S768, S768m, S768xm, S960m): Specifies the HANA instance SKU.\n  * hardwareType `string` (values: Cisco_UCS, HPE): Name of the hardware type (vendor and/or their product name)\n\n### IpAddress\n* IpAddress `object`: Specifies the IP address of the network interface.\n  * ipAddress `string`: Specifies the IP address of the network interface.\n\n### MonitoringDetails\n* MonitoringDetails `object`: Details needed to monitor a Hana Instance\n  * hanaDbName `string`: Name of the database itself.\n  * hanaDbPassword `string`: Password for the HANA database to login for monitoring\n  * hanaDbSqlPort `integer`: The port number of the tenant DB. Used to connect to the DB.\n  * hanaDbUsername `string`: Username for the HANA database to login to for monitoring\n  * hanaHostname `string`: Hostname of the HANA Instance blade.\n  * hanaSubnet `string`: ARM ID of an Azure Subnet with access to the HANA instance.\n\n### NetworkProfile\n* NetworkProfile `object`: Specifies the network settings for the HANA instance disks.\n  * circuitId `string`: Specifies the circuit id for connecting to express route.\n  * networkInterfaces `array`: Specifies the network interfaces for the HANA instance.\n    * items [IpAddress](#ipaddress)\n\n### OSProfile\n* OSProfile `object`: Specifies the operating system settings for the HANA instance.\n  * computerName `string`: Specifies the host OS name of the HANA instance.\n  * osType `string`: This property allows you to specify the type of the OS.\n  * sshPublicKey `string`: Specifies the SSH public key used to access the operating system.\n  * version `string`: Specifies version of operating system.\n\n### Operation\n* Operation `object`: HANA operation information\n  * display [Display](#display)\n  * name `string`: The name of the operation being performed on this particular object. This name should match the action name that appears in RBAC / the event service.\n\n### OperationList\n* OperationList `object`: List of HANA operations\n  * value `array`: List of HANA operations\n    * items [Operation](#operation)\n\n### Resource\n* Resource `object`: The resource model definition.\n  * id `string`: Resource ID\n  * location `string`: Resource location\n  * name `string`: Resource name\n  * tags `object`: Resource tags\n  * type `string`: Resource type\n\n### SapMonitor\n* SapMonitor `object`: SAP monitor info on Azure (ARM properties and SAP monitor properties)\n  * properties [SapMonitorProperties](#sapmonitorproperties)\n  * id `string`: Resource ID\n  * location `string`: Resource location\n  * name `string`: Resource name\n  * tags `object`: Resource tags\n  * type `string`: Resource type\n\n### SapMonitorListResult\n* SapMonitorListResult `object`: The response from the List SAP monitors operation.\n  * nextLink `string`: The URL to get the next set of SAP monitors.\n  * value `array`: The list of SAP monitors.\n    * items [SapMonitor](#sapmonitor)\n\n### SapMonitorProperties\n* SapMonitorProperties `object`: Describes the properties of a SAP monitor.\n  * enableCustomerAnalytics `boolean`: The value indicating whether to send analytics to Microsoft\n  * hanaDbCredentialsMsiId `string`: MSI ID passed by customer which has access to customer's KeyVault and to be assigned to the Collector VM.\n  * hanaDbName `string`: Database name of the HANA instance.\n  * hanaDbPassword `string`: Database password of the HANA instance.\n  * hanaDbPasswordKeyVaultUrl `string`: KeyVault URL link to the password for the HANA database.\n  * hanaDbSqlPort `integer`: Database port of the HANA instance.\n  * hanaDbUsername `string`: Database username of the HANA instance.\n  * hanaHostname `string`: Hostname of the HANA instance.\n  * hanaSubnet `string`: Specifies the SAP monitor unique ID.\n  * keyVaultId `string`: Key Vault ID containing customer's HANA credentials.\n  * logAnalyticsWorkspaceArmId `string`: The ARM ID of the Log Analytics Workspace that is used for monitoring\n  * logAnalyticsWorkspaceId `string`: The workspace ID of the log analytics workspace to be used for monitoring\n  * logAnalyticsWorkspaceSharedKey `string`: The shared key of the log analytics workspace that is used for monitoring\n  * managedResourceGroupName `string`: The name of the resource group the SAP Monitor resources get deployed into.\n  * provisioningState `string` (values: Accepted, Creating, Updating, Failed, Succeeded, Deleting, Migrating): State of provisioning of the HanaInstance\n\n### StorageProfile\n* StorageProfile `object`: Specifies the storage settings for the HANA instance disks.\n  * nfsIpAddress `string`: IP Address to connect to storage.\n  * osDisks `array`: Specifies information about the operating system disk used by the hana instance.\n    * items [Disk](#disk)\n\n### Tags\n* Tags `object`: Tags field of the HANA instance.\n  * tags `object`: Tags field of the HANA instance."},"npm":{"downloads":[{"from":"2022-07-13T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":4},{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":8},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":22},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":60},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":137}],"starsCount":0},"github":{"starsCount":129,"forksCount":52,"subscribersCount":11,"issues":{"count":62,"openCount":28,"distribution":{"3600":2,"10800":2,"32400":3,"97200":3,"291600":3,"874800":8,"2624400":3,"7873200":6,"23619600":9,"70858800":11,"212576400":12},"isDisabled":false},"contributors":[{"username":"shakya008","commitsCount":3},{"username":"DataFire","commitsCount":3},{"username":"rbren","commitsCount":354},{"username":"coderofsalvation","commitsCount":2},{"username":"rion18","commitsCount":1},{"username":"dmonaldo","commitsCount":1},{"username":"0xjjpa","commitsCount":1},{"username":"Lincoln23","commitsCount":1}],"commits":[{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-06-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-04-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2022-01-15T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0},{"from":"2021-07-14T00:00:00.000Z","to":"2022-07-14T00:00:00.000Z","count":0}],"statuses":[{"context":"continuous-integration/travis-ci/push","state":"failure"}]},"source":{"files":{"readmeSize":19467,"testsSize":40861},"badges":[{"urls":{"original":"https://travis-ci.org/DataFire/Integrations.svg?branch=master","service":"https://api.travis-ci.org/DataFire/Integrations.svg?branch=master","shields":"https://img.shields.io/travis/DataFire/Integrations/master.svg","content":"https://img.shields.io/travis/DataFire/Integrations/master.json"},"info":{"service":"travis","type":"build","modifiers":{"branch":"master"}}}]}},"evaluation":{"quality":{"carefulness":0.71,"tests":0.3,"health":1,"branding":0.15},"popularity":{"communityInterest":200,"downloadsCount":7.333333333333333,"downloadsAcceleration":-0.03767123287671234,"dependentsCount":0},"maintenance":{"releasesFrequency":0.29897260273972603,"commitsFrequency":0,"openIssues":0.5806451612903226,"issuesDistribution":0}},"score":{"final":0.3490960348913933,"detail":{"quality":0.8361096263359268,"popularity":0.10424726613196153,"maintenance":0.17650458241265357}}}