Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/services/serviceBusManagement2/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Microsoft
Copyright (c) 2019 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
32 changes: 16 additions & 16 deletions lib/services/serviceBusManagement2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,41 @@ uid: azure-arm-sb
summary: *content

---
# Microsoft Azure SDK for Node.js - ServiceBusManagementClient
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - ServiceBusManagementClient

This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

## Features
### Features


## How to Install
### How to Install

```bash
npm install azure-arm-sb
```

## How to use
### How to use

### Authentication, client creation and list operations as an example.
#### Authentication, client creation, and list operations as an example.

```javascript
const msRestAzure = require("ms-rest-azure");
const ServiceBusManagementClient = require("azure-arm-sb");
msRestAzure.interactiveLogin().then((creds) => {
const subscriptionId = "<Subscription_Id>";
const client = new ServiceBusManagementClient(creds, subscriptionId);
return client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
});
const subscriptionId = "<Subscription_Id>";
const client = new ServiceBusManagementClient(creds, subscriptionId);

return client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});

## Related projects
```
### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)


![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-node%2Flib%2Fservices%2FserviceBusManagement2%2FREADME.png)
17 changes: 9 additions & 8 deletions lib/services/serviceBusManagement2/lib/models/accessKeys.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,20 @@
class AccessKeys {
/**
* Create a AccessKeys.
* @member {string} [primaryConnectionString] Primary connection string of
* @property {string} [primaryConnectionString] Primary connection string of
* the created namespace authorization rule.
* @member {string} [secondaryConnectionString] Secondary connection string
* @property {string} [secondaryConnectionString] Secondary connection string
* of the created namespace authorization rule.
* @member {string} [aliasPrimaryConnectionString] Primary connection string
* of the alias if GEO DR is enabled
* @member {string} [aliasSecondaryConnectionString] Secondary connection
* @property {string} [aliasPrimaryConnectionString] Primary connection
* string of the alias if GEO DR is enabled
* @member {string} [primaryKey] A base64-encoded 256-bit primary key for
* @property {string} [aliasSecondaryConnectionString] Secondary connection
* string of the alias if GEO DR is enabled
* @property {string} [primaryKey] A base64-encoded 256-bit primary key for
* signing and validating the SAS token.
* @member {string} [secondaryKey] A base64-encoded 256-bit primary key for
* @property {string} [secondaryKey] A base64-encoded 256-bit primary key for
* signing and validating the SAS token.
* @member {string} [keyName] A string that describes the authorization rule.
* @property {string} [keyName] A string that describes the authorization
* rule.
*/
constructor() {
}
Expand Down
10 changes: 5 additions & 5 deletions lib/services/serviceBusManagement2/lib/models/action.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
class Action {
/**
* Create a Action.
* @member {string} [sqlExpression] SQL expression. e.g. MyProperty='ABC'
* @member {number} [compatibilityLevel] This property is reserved for future
* use. An integer value showing the compatibility level, currently
* @property {string} [sqlExpression] SQL expression. e.g. MyProperty='ABC'
* @property {number} [compatibilityLevel] This property is reserved for
* future use. An integer value showing the compatibility level, currently
* hard-coded to 20.
* @member {boolean} [requiresPreprocessing] Value that indicates whether the
* rule action requires preprocessing. Default value: true .
* @property {boolean} [requiresPreprocessing] Value that indicates whether
* the rule action requires preprocessing. Default value: true .
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ const models = require('./index');
class ArmDisasterRecovery extends models['Resource'] {
/**
* Create a ArmDisasterRecovery.
* @member {string} [provisioningState] Provisioning state of the
* @property {string} [provisioningState] Provisioning state of the
* Alias(Disaster Recovery configuration) - possible values 'Accepted' or
* 'Succeeded' or 'Failed'. Possible values include: 'Accepted', 'Succeeded',
* 'Failed'
* @member {number} [pendingReplicationOperationsCount] Number of entities
* @property {number} [pendingReplicationOperationsCount] Number of entities
* pending to be replicated.
* @member {string} [partnerNamespace] ARM Id of the Primary/Secondary
* eventhub namespace name, which is part of GEO DR pairning
* @member {string} [alternateName] Primary/Secondary eventhub namespace
* name, which is part of GEO DR pairning
* @member {string} [role] role of namespace in GEO DR - possible values
* @property {string} [partnerNamespace] ARM Id of the Primary/Secondary
* eventhub namespace name, which is part of GEO DR pairing
* @property {string} [alternateName] Primary/Secondary eventhub namespace
* name, which is part of GEO DR pairing
* @property {string} [role] role of namespace in GEO DR - possible values
* 'Primary' or 'PrimaryNotReplicating' or 'Secondary'. Possible values
* include: 'Primary', 'PrimaryNotReplicating', 'Secondary'
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@
class ArmDisasterRecoveryListResult extends Array {
/**
* Create a ArmDisasterRecoveryListResult.
* @member {string} [nextLink] Link to the next set of results. Not empty if
* Value contains incomplete list of Alias(Disaster Recovery configuration)
* @property {string} [nextLink] Link to the next set of results. Not empty
* if Value contains incomplete list of Alias(Disaster Recovery
* configuration)
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class AuthorizationRuleProperties {
/**
* Create a AuthorizationRuleProperties.
* @member {array} rights The rights associated with the rule.
* @property {array} rights The rights associated with the rule.
*/
constructor() {
}
Expand Down
28 changes: 14 additions & 14 deletions lib/services/serviceBusManagement2/lib/models/captureDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,24 @@
class CaptureDescription {
/**
* Create a CaptureDescription.
* @member {boolean} [enabled] A value that indicates whether capture
* @property {boolean} [enabled] A value that indicates whether capture
* description is enabled.
* @member {string} [encoding] Enumerates the possible values for the
* @property {string} [encoding] Enumerates the possible values for the
* encoding format of capture description. Possible values include: 'Avro',
* 'AvroDeflate'
* @member {number} [intervalInSeconds] The time window allows you to set the
* frequency with which the capture to Azure Blobs will happen, value should
* between 60 to 900 seconds
* @member {number} [sizeLimitInBytes] The size window defines the amount of
* data built up in your Event Hub before an capture operation, value should
* be between 10485760 and 524288000 bytes
* @member {object} [destination] Properties of Destination where capture
* @property {number} [intervalInSeconds] The time window allows you to set
* the frequency with which the capture to Azure Blobs will happen, value
* should between 60 to 900 seconds
* @property {number} [sizeLimitInBytes] The size window defines the amount
* of data built up in your Event Hub before an capture operation, value
* should be between 10485760 and 524288000 bytes
* @property {object} [destination] Properties of Destination where capture
* will be stored. (Storage Account, Blob Names)
* @member {string} [destination.name] Name for capture destination
* @member {string} [destination.storageAccountResourceId] Resource id of the
* storage account to be used to create the blobs
* @member {string} [destination.blobContainer] Blob container Name
* @member {string} [destination.archiveNameFormat] Blob naming convention
* @property {string} [destination.name] Name for capture destination
* @property {string} [destination.storageAccountResourceId] Resource id of
* the storage account to be used to create the blobs
* @property {string} [destination.blobContainer] Blob container Name
* @property {string} [destination.archiveNameFormat] Blob naming convention
* for archive, e.g.
* {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}.
* Here all the parameters (Namespace,EventHub .. etc) are mandatory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class CheckNameAvailability {
/**
* Create a CheckNameAvailability.
* @member {string} name The Name to check the namespce name availability and
* The namespace name can contain only letters, numbers, and hyphens. The
* @property {string} name The Name to check the namespace name availability
* and The namespace name can contain only letters, numbers, and hyphens. The
* namespace must start with a letter, and it must end with a letter or
* number.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
class CheckNameAvailabilityResult {
/**
* Create a CheckNameAvailabilityResult.
* @member {string} [message] The detailed info regarding the reason
* @property {string} [message] The detailed info regarding the reason
* associated with the namespace.
* @member {boolean} [nameAvailable] Value indicating namespace is
* @property {boolean} [nameAvailable] Value indicating namespace is
* availability, true if the namespace is available; otherwise, false.
* @member {string} [reason] The reason for unavailability of a namespace.
* @property {string} [reason] The reason for unavailability of a namespace.
* Possible values include: 'None', 'InvalidName', 'SubscriptionIsDisabled',
* 'NameInUse', 'NameInLockdown', 'TooManyNamespaceInCurrentSubscription'
*/
Expand Down
22 changes: 11 additions & 11 deletions lib/services/serviceBusManagement2/lib/models/correlationFilter.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@
class CorrelationFilter {
/**
* Create a CorrelationFilter.
* @member {object} [properties] dictionary object for custom filters
* @member {string} [correlationId] Identifier of the correlation.
* @member {string} [messageId] Identifier of the message.
* @member {string} [to] Address to send to.
* @member {string} [replyTo] Address of the queue to reply to.
* @member {string} [label] Application specific label.
* @member {string} [sessionId] Session identifier.
* @member {string} [replyToSessionId] Session identifier to reply to.
* @member {string} [contentType] Content type of the message.
* @member {boolean} [requiresPreprocessing] Value that indicates whether the
* rule action requires preprocessing. Default value: true .
* @property {object} [properties] dictionary object for custom filters
* @property {string} [correlationId] Identifier of the correlation.
* @property {string} [messageId] Identifier of the message.
* @property {string} [to] Address to send to.
* @property {string} [replyTo] Address of the queue to reply to.
* @property {string} [label] Application specific label.
* @property {string} [sessionId] Session identifier.
* @property {string} [replyToSessionId] Session identifier to reply to.
* @property {string} [contentType] Content type of the message.
* @property {boolean} [requiresPreprocessing] Value that indicates whether
* the rule action requires preprocessing. Default value: true .
*/
constructor() {
}
Expand Down
8 changes: 4 additions & 4 deletions lib/services/serviceBusManagement2/lib/models/destination.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
class Destination {
/**
* Create a Destination.
* @member {string} [name] Name for capture destination
* @member {string} [storageAccountResourceId] Resource id of the storage
* @property {string} [name] Name for capture destination
* @property {string} [storageAccountResourceId] Resource id of the storage
* account to be used to create the blobs
* @member {string} [blobContainer] Blob container Name
* @member {string} [archiveNameFormat] Blob naming convention for archive,
* @property {string} [blobContainer] Blob container Name
* @property {string} [archiveNameFormat] Blob naming convention for archive,
* e.g.
* {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}.
* Here all the parameters (Namespace,EventHub .. etc) are mandatory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
'use strict';

/**
* Error reponse indicates ServiceBus service is not able to process the
* Error response indicates ServiceBus service is not able to process the
* incoming request. The reason is provided in the error message.
*
*/
class ErrorResponse {
/**
* Create a ErrorResponse.
* @member {string} [code] Error code.
* @member {string} [message] Error message indicating why the operation
* @property {string} [code] Error code.
* @property {string} [message] Error message indicating why the operation
* failed.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
class EventHubListResult extends Array {
/**
* Create a EventHubListResult.
* @member {string} [nextLink] Link to the next set of results. Not empty if
* Value contains incomplete list of EventHubs.
* @property {string} [nextLink] Link to the next set of results. Not empty
* if Value contains incomplete list of EventHubs.
*/
constructor() {
super();
Expand Down
42 changes: 22 additions & 20 deletions lib/services/serviceBusManagement2/lib/models/eventhub.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,38 +20,40 @@ const models = require('./index');
class Eventhub extends models['Resource'] {
/**
* Create a Eventhub.
* @member {array} [partitionIds] Current number of shards on the Event Hub.
* @member {date} [createdAt] Exact time the Event Hub was created.
* @member {date} [updatedAt] The exact time the message was updated.
* @member {number} [messageRetentionInDays] Number of days to retain the
* @property {array} [partitionIds] Current number of shards on the Event
* Hub.
* @property {date} [createdAt] Exact time the Event Hub was created.
* @property {date} [updatedAt] The exact time the message was updated.
* @property {number} [messageRetentionInDays] Number of days to retain the
* events for this Event Hub, value should be 1 to 7 days
* @member {number} [partitionCount] Number of partitions created for the
* @property {number} [partitionCount] Number of partitions created for the
* Event Hub, allowed values are from 1 to 32 partitions.
* @member {string} [status] Enumerates the possible values for the status of
* the Event Hub. Possible values include: 'Active', 'Disabled', 'Restoring',
* 'SendDisabled', 'ReceiveDisabled', 'Creating', 'Deleting', 'Renaming',
* 'Unknown'
* @member {object} [captureDescription] Properties of capture description
* @member {boolean} [captureDescription.enabled] A value that indicates
* @property {string} [status] Enumerates the possible values for the status
* of the Event Hub. Possible values include: 'Active', 'Disabled',
* 'Restoring', 'SendDisabled', 'ReceiveDisabled', 'Creating', 'Deleting',
* 'Renaming', 'Unknown'
* @property {object} [captureDescription] Properties of capture description
* @property {boolean} [captureDescription.enabled] A value that indicates
* whether capture description is enabled.
* @member {string} [captureDescription.encoding] Enumerates the possible
* @property {string} [captureDescription.encoding] Enumerates the possible
* values for the encoding format of capture description. Possible values
* include: 'Avro', 'AvroDeflate'
* @member {number} [captureDescription.intervalInSeconds] The time window
* @property {number} [captureDescription.intervalInSeconds] The time window
* allows you to set the frequency with which the capture to Azure Blobs will
* happen, value should between 60 to 900 seconds
* @member {number} [captureDescription.sizeLimitInBytes] The size window
* @property {number} [captureDescription.sizeLimitInBytes] The size window
* defines the amount of data built up in your Event Hub before an capture
* operation, value should be between 10485760 and 524288000 bytes
* @member {object} [captureDescription.destination] Properties of
* @property {object} [captureDescription.destination] Properties of
* Destination where capture will be stored. (Storage Account, Blob Names)
* @member {string} [captureDescription.destination.name] Name for capture
* @property {string} [captureDescription.destination.name] Name for capture
* destination
* @member {string} [captureDescription.destination.storageAccountResourceId]
* Resource id of the storage account to be used to create the blobs
* @member {string} [captureDescription.destination.blobContainer] Blob
* @property {string}
* [captureDescription.destination.storageAccountResourceId] Resource id of
* the storage account to be used to create the blobs
* @property {string} [captureDescription.destination.blobContainer] Blob
* container Name
* @member {string} [captureDescription.destination.archiveNameFormat] Blob
* @property {string} [captureDescription.destination.archiveNameFormat] Blob
* naming convention for archive, e.g.
* {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}.
* Here all the parameters (Namespace,EventHub .. etc) are mandatory
Expand Down
Loading