Giter Site home page Giter Site logo

microsoftdocs / azure-docs-sdk-node Goto Github PK

View Code? Open in Web Editor NEW
80.0 30.0 179.0 403.42 MB

Azure for JavaScript and Node.js developers documentation on docs.microsoft.com.

Home Page: https://docs.microsoft.com/en-us/javascript/azure/

License: Creative Commons Attribution 4.0 International

ms-x-reference

azure-docs-sdk-node's Introduction

Azure for JavaScript & Node.js developers Documentation

This repository contains the reference documentation for the "Azure for JavaScript & Node.js" SDK.

Conceptual documentation has been moved to https://github.com/microsoftdocs/azure-dev-docs - please contribute changes and file issues there.

Reference documentation is generated from a CI job located here..

Package targeting is established in the ci-configs directory.

Legal Notices

Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE file.

Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.

Privacy information can be found at https://privacy.microsoft.com/

Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.

azure-docs-sdk-node's People

Contributors

auchenberg avatar azure-sdk avatar burkeholland avatar craigshoemaker avatar danieljurek avatar dend avatar harshanalluru avatar herohua avatar jasonwhowell avatar jawache avatar jeremymeng avatar johnpapa avatar karlerickson avatar ljian3377 avatar openpublishbuild avatar patrickfarley avatar ramya-rao-a avatar rloutlaw avatar sadasant avatar saisang avatar sankethka avatar scbedd avatar sima-zhu avatar taojunshen avatar tomarchermsft avatar v-alje avatar vsc-service-account avatar wuhanyumsft avatar yannanwang1 avatar yunair avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Forkers

yunyunyunyun v-kents chrisdias burkeholland markmcgeeataquent clarkio jawache simonaco thedanfernandez lisawong19 spboyer rloutlaw erickson-doug arob98 cjgronlund carlrabeler translucens vladbarosan craigshoemaker tamram itye-msft carolinacmoravia sarah-barrett esthergaddindla mimig1 sandeepchads mmacy rekha-balan bowdenk7 v-thepet v-maudel jasonwhowell nschonni tfitzmac sudeepku mahilleb-msft daveba kingdomofends kngo5553 georgewallace pataltimore auchenberg karlerickson v-makoud garyericson makanwg ghogen xiangyul-microsoft ramthi jeahyoun v-mamaz peachying craigcaseymsft zhiliangxu ops-e2e-ppe heidisteen tchristiani mormond dcurwin markingmyname msmbaldwin jasonmerino joemccann snehagunda scbedd elraikhm sizwed harshanalluru azurementor chidozieononiwu maggiepint uzresk spelluru xuguang-yao jongkukjaylee azure-sdk dennislee-dennislee celestedg philmea rboucher bandersmsft dominicbetts ljian3377 joheredi davidcberry13 patrickfarley sima-zhu vassilis-karapatakis mashamsft richardpark-msft shi-ding damabe mpodwysocki qiaozha zfoster mikekinsman ellismg kenanlv remnantkevin jeremymeng

azure-docs-sdk-node's Issues

Examples!

Any API documentation is 10-100X more valuable if concrete examples are provided for common processes such as an end-to-end example of a device provisioning itself, setting tags, etc...

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

in the options blobAccessConditions should be accessConditions

Check the implementation of the block blob upload for usage, this is current a direct line to a line of code, however just take a look at the implementation of the BlockBlobURL.upload function:

https://github.com/Azure/azure-storage-js/blob/a1b7084089bf85dd166aa8e89745964ea263d13a/blob/lib/BlockBlobURL.ts#L180

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

More realistic example using FileShare to download images

Hi I am looking for a more realistic example of Node.JS SDK for File Share client API that showcases downloading. something like a image. or pdf file and not just a simple text file.
My problem is with the download example it does not show how to treat binary content.
In particular the example:

basic auth

And the function:

async function streamToString(readableStream: NodeJS.ReadableStream)

I would like to see an example on stream to byte array.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Usage of this page via Azure Portal

When you visit the Overview page of a Storage Account in the Azure Portal, there is a Tools and SDKs -> Node.js link that points to this page, hosting it in an iframe

There are a number of links on this page to npm for the storage client libraries

npm sets the "x-frame-options: DENY" header, which prevents it from being displayed in said iframe

The end result is that when trying to learn how to use Azure Storage with JS from the Azure Portal, you get a broken link

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Aborter.None has been renamed to Aborter.none in 10.1.0-preview of @azure/storage-blob

Aborter.None has been renamed to Aborter.none in 10.1.0-preview of @azure/storage-blob, seems the document above is not fully updated.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Need client samples for Key Vault

The key vault docs only include the management plane pieces. This should be expanded to show the client functionality or, at least, point to the client SDK for these kinds of operations:

  • Manage keys: create, import, update, delete, backup, restore, list and get
  • Key operations: sign, verify, encrypt, decrypt, wrap, unwrap
  • Secret operations: set, get, update and list
  • Certificate operations: create, get, update, import, list, and manage contacts and issuers

azure-eventgrid EventGridClient() second argument

The Documentation states pass a string of 'your-subsciber-id' when the latest package from npm takes an optional argument of AzureServiceClientOptions

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Landing page: Clean up "Overview" node

We should clean up the "Overview" node by either removing it, or adding more content to. "Azure Modules" node doesn't make much sense on the context of not being SDK/reference docs.

screen shot 2019-02-22 at 4 38 05 pm

Add API Docs to API Reference

I followed links to an API library reference. I expected to see API documentation but found none. Please offer documentation of the API.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

wheres the source

is the source for this SDK up somewhere or is all we get the zip with the bundle in it

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Sample links return 404 pages

The two links in the 'Samples' section at the bottom of the page return 404 pages.
The links anchor text are:

  • Securing a web API with Azure AD
  • Integrating Azure AD into a NodeJS web application

Screen Shot 2020-07-16 at 4 54 44 PM

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Use async / await with try catch on demo docs.

[Enter feedback here]
The document looks quite old and it requires more cognitive effort to read for developers used to async/await in NodeJS.

To solve the issue, implementing the sample on async/await with try catch will reduce callback hell and cognitive workload required to understand sample better.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Error: client.profiles.listAllInResourceGroup is not a function

Received error when trying run code from example (in Azure Function App).
My code:

const RestAzure = require('ms-rest-azure');
const TrafficManager = require('azure-arm-trafficmanager');

module.exports = function (context, myTimer) {
    RestAzure.loginWithServicePrincipalSecret('...', '...', '...').then(credentials => {
        const client = new TrafficManager(credentials, '...');
        return client.profiles.listAllInResourceGroup('test-traffic');
    }).then(profiles => {
        profiles.map(profile => {
            context.log(`found profile : ${profile.name}`);
        });
        context.done();
    }).catch(err => {
        context.log('Error: ' + err.message);
        context.done();
    });
};

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

404 link

Link "App Service Mobile completed quickstart for JavaScript backend" is 404

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

npm package confusion azure- or @azure/?

These docs references the package azure-eventgrid but if you look at "Client" in the side menu it shows the API for @azure/eventgrid - Which one is correct?

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Device Id

Should the device description have the additional fields listed here that are available, but undocumented in MS Docs like status and authentication? (see this PR Azure/azure-iot-sdk-node#309)

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Cannot access 'vn' before initialization

I have integrated Microsoft azure speech to text in my angular 8 application.

It is working on locally but when i deployed my code to test env it's giving me error 'Cannot access 'vn' before initialization' on this line const sdk = require('microsoft-cognitiveservices-speech-sdk');.

My test env is unsecured network.

Below is my code:

starAudioRecording() {
const audioConstraints = {
audio: true,
video: false
};
navigator.mediaDevices
.getUserMedia(audioConstraints)
.then(this.successCallback.bind(this), this.errorCallback.bind(this));
}

successCallback(stream) {
    const options = {
        mimeType: 'audio/wav',
        numberOfAudioChannels: 1
    };
    const StereoAudioRecorder = RecordRTC.StereoAudioRecorder;
    this.recorder = new StereoAudioRecorder(stream, options);
    this.recorder.record();
}

stopRecording() {
    setTimeout(() => {
        this.recorder.stop(this.processRecording.bind(this));
    }, 1000);
}

processRecording(blob) {
    console.log(blob);
    this.blob = URL.createObjectURL(blob);
    setTimeout(() => {
        const fileObject = new File([blob], 'audio.wav');
        this.RecognizerStart(fileObject);
    }, 1000);
}

errorCallback(error) {
    console.log('Can not play audio in your browser');
    this.resultText = 'media is not supported in your browser';
}

RecognizerStart(audioFile) {
    const sdk = require('microsoft-cognitiveservices-speech-sdk');
    console.log(sdk);
    const audioConfig = sdk.AudioConfig.fromWavFileInput(audioFile);
    console.log('audioConfig' + audioConfig);
    const speechConfig = sdk.SpeechConfig.fromSubscription('29d1eb8c7bef4d7dadd0d5ea9d22ac20', 'centralindia');
    console.log('speechConfig' + speechConfig);
    speechConfig.speechRecognitionLanguage = 'en-US';
    let recognizer = new sdk.SpeechRecognizer(speechConfig, audioConfig);
    console.log('recognizer' + recognizer);
    // Start the recognizer and wait for a result.
    recognizer.recognizeOnceAsync(
        result => {
            console.log(result.text);
            this.resultText = result.text;
            recognizer.close();
            recognizer = undefined;
        },
        err => {
            console.log('err - ' + err);

            recognizer.close();
            recognizer = undefined;
        }
    );
}

Backup.md example -> TypeError: client.jobs.list is not a function

Hi,

When I execute code example provided at
https://github.com/MicrosoftDocs/azure-docs-sdk-node/blob/master/docs-ref-services/backup.md I get the following error message:

To sign in, use a web browser to open the page https://aka.ms/devicelogin and enter the code CA3LZDEPE to authenticate. TypeError: client.jobs.list is not a function at msRestAzure.interactiveLogin.then.credentials (C:\Temp\AzureFunction\BackupCheck.js:15:24) at <anonymous> at process._tickCallback (internal/process/next_tick.js:188:7)

I did provide the subscriptionId, vault and resourceGroupName information.

Can you please point out what I'm doing wrong?

Cheers,
Marc

Content is ancient

This is linked to from the main "Getting started with Azure and JavaScript" page https://docs.microsoft.com/en-us/javascript/azure/?view=azure-node-latest

Yet the content is extremely out of date an uses the deprecated SDK https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/Migration.md

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Please update the Samples link.

This is out dated and shows 404 page not found:

https://docs.microsoft.com/en-us/javascript/api/overview/azure/storage?view=azure-node-latest#samples

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Getting error on the 'get' method for this class

Getting an error when trying to invoke the 'get' method on an object returned from the Client getTwin() method. The get method does not exist.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

parameter name changed to includeTotalCount

This page says to get the search result count, use a parameter called "includeTotalResultCount" which is no longer correct as of 11.0.0 (per the changeling). The correct parameter name is includeTotalCount. In 11.0.3 (perhaps other versions as well), the old parameter name fails to return a count.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Azure Search is rebranded

Can you change the service name to "Azure Cognitive Search" and the metadata to "cognitive-search". There is no change to package names, etc. It's a marketing/rebranding effort only.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Do we have ConfigureRefresh kind option available like .NET SDK

Do we have ConfigureRefresh kind option available like .NET SDK? basically like to refresh Key values in specific interval or do it in event driven way

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

toArray doesn't return Promise at all!

This document is a little deceptive? The API doesn't support Promise as far as I can see from the source code. You still need to pass in a callback function to e.g. toArray() and can't use:
var docs = await iter.toArray()

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Bad tutorial link

I get page not found error when I click on "Developing a JavaScript app using CosmosDB API" which is a link to https://azure.microsoft.com/en-us/resources/samples/azure-cosmos-db-documentdb-nodejs-getting-started/

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Links broken

The following links don't work:

Securing a web API with Azure AD - https://azure.microsoft.com/resources/samples/active-directory-node-webapi/

Integrating Azure AD into a NodeJS web application - https://azure.microsoft.com/resources/samples/active-directory-node-webapp-openidconnect/

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

How to create a table?

How to create a table?
How to create a method like createTableIfNotExisting?

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Missing API reference for Node.js

Azure Storage is a commodity service and Node.js is one of the most popular runtimes in the world and we don't have detailed documentation (an API reference) for it. I search Azure Storage Documentation for a certain method (listBlobsSegmented) and I get 0 results.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.