Azure SDK for JavaScript (September 2021)
The Azure SDK team is pleased to announce our September 2021 client library releases.
54 packages released this month.
Stable Packages (8)
-
Attestation
-
Core - HTTP
-
Core Rest Pipeline
-
Cosmos DB
-
Storage - Blobs
-
Storage - Files Data Lake
-
Storage - Files Shares
-
Storage - Queues
Patch Updates (5)
-
Cognitive Search
-
Communication Chat
-
Cosmos DB
-
Identity
-
Tables
Beta Packages (32)
-
Cognitive Search
-
Communication Chat
-
Container Registry
-
Core - Rest
-
Event Hubs - Schema Registry
-
Event Hubs - Schema Registry Avro
-
Identity
-
Identity Cache Persistence
-
Identity Visual Studio Code Credential
-
Key Vault - Certificates
-
Key Vault - Secrets
-
Monitor Query
-
Resouce Management - Resources Subscriptions
-
Resource Management - App Service
-
Resource Management - Authorization
-
Resource Management - Compute
-
Resource Management - Event Hubs
-
Resource Management - Features
-
Resource Management - Key Vault
-
Resource Management - Links
-
Resource Management - Locks
-
Resource Management - Managed Applications
-
Resource Management - Network
-
Resource Management - Policy
-
Resource Management - Purview
-
Resource Management - Resources
-
Resource Management - SQL
-
Resource Management - Service Bus
-
Resource Management - Storage
-
Resource Management - Template Specs
-
Resource Management - WebPubSub
-
Synapse - Managed Private Endpoints
Release highlights
Attestation 1.0.0 Changelog
Breaking Changes
- Reversed the order of
credentials
andendpoint
inAttestationAdministrationClient
to be consistent with other SDKs. - Removed
credentials
top level parameter forAttestationClient
constructor, moved to theAttestationClientOptions
object. - Renamed the
validateToken
API in theAttestationToken
class togetTokenProblems
returning an array of strings. - Attestation Policy APIs (
setPolicy
,resetPolicy
) have had theirprivateKey
andcertificate
parameters moved to options. - Renamed
instanceUrl
toendpoint
to be consistent with other APIs. - Removed
policyCertificates
fromAttestationAdministrationClient
. - Removed
StoredAttestationPolicy
and replaced it withAttestationPolicyToken
. - Removed
AttestationData
type. Instead of specifying anAttestationData
forinitTimeData
andrunTimeData
to the Attest APIs, the attest APIs take aninitTimeJson
,initTimeData
,runTimeData
andrunTimeJson
object and determine theDataType
to send to the server based on that. - Removed the
AttestationSigningKey
model type replaced with two parametersprivateKey
andcertificate
to the APIs which used to accept anAttestationSigningKey
- Renamed
AttestationResponse.value
toAttestationResponse.body
to align with API guidelines.
Features Added
Added hand authored implementation for policy management certificate APIs: getPolicyManagementCertificates
, addPolicyManagementCertificate
and removePolicyManagementCertificate
.
Simplified the calling pattern for the Attest family of APIs. Simplified some model types to be reflected as either parameters or interfaces. The attestation family of APIs no longer requires authentication credentials. The attestation family of APIs now accepts Blob objects in addition to Uint8Array and Buffer objects as inputs.
Cognitive Search 11.3.0-beta.3 Changelog
Features Added
- Added a new property
normalizerName
to theAnalyzeRequest
object. - Added 2 new properties
captions
&semanticFields
to theSearchRequestOptions
object.
Cognitive Search 11.2.1 Changelog
New Features
- Support for Node.js 8 and IE 11 has been dropped. Please see our support policy for more details.
- Changed TS compilation target to ES2017 to produce smaller bundles and use more native platform features.
- Updated our internal core package dependencies to their latest versions to add support for Opentelemetry 1.0.0, which is compatible with the latest versions of our other client libraries.
Communication Chat 1.1.0-beta.2 Changelog
- Updated to @azure/communication-signaling@1.0.0-beta.8.
Communication Chat 1.0.1 Changelog
- Updated to @azure/communication-signaling@1.0.0-beta.8.
Container Registry 1.0.0-beta.4 Changelog
Breaking Changes
UpdateManifestPropertiesOptions
is no longer optional.
Container Registry 1.0.0-beta.5 Changelog
Breaking Changes
- Replace
authenticationScope
withaudience
inContainerRegistryClientOptions
. An extensible enumKnownContainerRegistryAudience
is introduced which has known audience values.
Core - HTTP 2.2.0 Changelog
Bugs Fixed
tracingPolicy
will no longer propagate tracing errors to the caller, and such errors will be logged instead and the operation does not get interrupted. PR #16916
Core - Rest 1.0.0-beta.7 Changelog
Other Changes
- Create pipeline from scratch excluding tracingPolicy to decrease bundle size. #17015
- Allow number and boolean as input headers. #17358
Core Rest Pipeline 1.3.0 Changelog
Bugs Fixed
tracingPolicy
will no longer propagate tracing errors to the caller, and such errors will be logged instead and the operation does not get interrupted. PR #16916
Cosmos DB 3.13.0 Changelog
Features Added
- Adds TransactionalBatch to items
container.items.batch(operations)
Bugs Fixed
- Fixed bulk requests which had operations without partitionKey specified.
Cosmos DB 3.13.1 Changelog
Bugs Fixed
- Fixed bugs in session token clearing logic. Session Not found (404, substatus 1002) was not being handled correctly by the session retry policy and would mistakenly retry the request with the same session token.
Cosmos DB 3.14.0 Changelog
Bugs Fixed
- Fixes bug where Batch was passing the wrong header for batch requests with partition keys
- Fixes 401s when using AAD auth. AAD credentials should now work and no longer cause 429s from @azure/identity at high throughput.
Features Added
- PREVIEW Adds
container.item(itemId).patch()
.patch()
is an alternative toreplace()
for item updates. https://github.com/Azure/azure-sdk-for-js/pull/16264/files#diff-7caca690c469e2025576523c0377ac71815f001024fde7c48b20cd24adaa6977R561 - PREVIEW Adds support for Bulk operation PATCH.
- PREVIEW Adds support for Batch operation PATCH.
Cosmos DB 3.14.1 Changelog
Bugs Fixed
- Fix @azure/core-rest-pipeline version for AAD auth.
Event Hubs - Schema Registry 1.0.0-beta.2 Changelog
Features Added
- Support caching of registered schemas and send requests to the service only if the cache does not have the looked-up schema/schema ID.
Breaking Changes
- Change SchemaRegistryClient.getSchemaId and SchemaRegistryClient.getSchemaById to return
undefined
instead of throwing when schema is not found (Issue #15130) - Move generated client to use @azure/core-rest-pipeline. For more information about Core V2, please refer to the documentation.
- With this change, the response types no longer contain the raw response
_response
. To access the raw response, anonResponse
callback has to be passed in the request options bag.
let createResult: FullOperationResponse | undefined;
await client.getSchemaById(id, { onResponse: (response) => (createResult = response) });
Event Hubs - Schema Registry Avro 1.0.0-beta.2 Changelog
Features Added
- Depends on @azure/schema-registry@1.0.0-beta.2 which supports client-level caching.
Identity 1.5.2 Changelog
- Fixed a bug introduced on 1.5.0 that caused the
ManagedIdentityCredential
to fail authenticating in Arc environments. Since our new core disables unsafe requests by default, we had to change the security settings for the first request of the Arc MSI, which retrieves the file path where the authentication value is stored since this request generally happens through an HTTP endpoint.
Identity 2.0.0-beta.6 Changelog
Breaking Changes
ClientCertificateCredential
now evaluates the validity of the PEM certificate path ongetToken
and not on the constructor.
Breaking Changes from 2.0.0-beta.5
- The property named
selectedCredential
that was added toChainedTokenCredential
andDefaultAzureCredential
has been removed, since customers reported that logging was enough. - Renamed the
allowUnencryptedStorage
property ofTokenCachePersistenceOptions
tounsafeAllowUnencryptedStorage
to make it clear that enabling the unencrypted storage feature is not generally safe for production use. - Changed the name of the “extension” API to the “plugin” API to reduce confusion between this package and VS Code extensions. The function
useIdentityExtension
was renamed touseIdentityPlugin
, and “extension packages” are now known as “plugin packages”. - Renamed the
allowUnencryptedStorage
property ofTokenCachePersistenceOptions
tounsafeAllowUnencryptedStorage
to make it clear that enabling the unencrypted storage feature is not generally safe for production use.
Bugs Fixed
ClientSecretCredential
,ClientCertificateCredential
andUsernamePasswordCredential
now throw if the required parameters are not provided (even in JavaScript).- Fixed a bug introduced on 2.0.0-beta.5 that caused the
ManagedIdentityCredential
to fail authenticating in Arc environments. Since our new core disables unsafe requests by default, we had to change the security settings for the first request of the Arc MSI, which retrieves the file path where the authentication value is stored since this request generally happens through an HTTP endpoint. - Fixed bug on the
AggregateAuthenticationError
, which caused an inconsistent error message on theChainedTokenCredential
,DefaultAzureCredential
andApplicationCredential
.
Features Added
- Added the
OnBehalfOfCredential
, which allows users to authenticate through the On-Behalf-Of authentication flow. ManagedIdentityCredential
now supports token exchange authentication.
Identity Cache Persistence 1.0.0-beta.2 Changelog
Bugs Fixed
- Updated
@azure/msal-node
and@azure/msal-node-extensions
, which fixed an issue that caused silent authentication to fail on requests with previously cached (and valid) tokens.
Identity Visual Studio Code Credential 1.0.0-beta.2 Changelog
Other Changes
- Changed the name of the “extension” API to the “plugin” API to reduce confusion between this package and VS Code extensions. This package is now a “plugin package.”
- Renamed
vsCodeExtension
tovsCodePlugin
.
Key Vault - Certificates 4.4.0-beta.1 Changelog
Other Changes
- Updated the latest service version to 7.3.
Key Vault - Secrets 4.4.0-beta.1 Changelog
Other Changes
- Updated the latest service version to 7.3.
Monitor Query 1.0.0-beta.5 Changelog
Features Added
- Added convenience method
getMetricByName
inMetricsQueryResult
to allow users to fetch results of a particular metric - Added a flag
throwOnAnyFailure
to be set by user for methodsqueryLogs
andqueryLogsBatch
to enable error throwing - Defining
AggregateBatchError
class for throwing batch errors - Added status with potential values
("Partial" | "Success" | "Failed")
for responses ofquery
andqueryBatch
APIs to indicate whether the status of results of each query.
Breaking Changes
- Updated methods
getMetricDefinitions
andgetMetricNamespaces
to return paginated list of items and renamed tolistMetricDefinitions
andlistMetricNames
respectively - Renamed methods
queryLogs
andqueryLogsBatch
inLogsQueryClient
toquery
andqueryBatch
- Updated the constant names inside
Durations
to drop thelast
prefix - Updated method
queryBatch
to take argument ofQueryBatch
model instead ofQueryLogsBatch
model - Renamed
QueryLogsOptions
toLogsQueryOptions
- Renamed
QueryLogsBatchResult
toLogsQueryBatchResult
- Renamed
QueryMetricsResult
toMetricsQueryResult
- Renamed
QueryLogsResult
toLogsQueryResult
,QueryLogsBatchOptions
toLogsQueryBatchOptions
- Updated type for
timespan
property fromstring
toTimeInterval
type inquery
andqueryBatch
methods ofLogsQueryClient
and inMetricsQueryResult
interface - Renamed
MetricColumn
toLogsColumn
andcolumn
tocolumnDescriptors
inLogsTable
model - Renamed
displayDescription
property todescription
inMetric
andMetricNames
- Flattened the
metricNamespaceName
property forMetricNamespace
- Renamed
innererror
toinnerError
inErrorInfo
Resouce Management - Resources Subscriptions 1.0.0-beta.1 Changelog
Resource Management - App Service 30.0.0-beta.1 Changelog
Resource Management - App Service 30.0.0-beta.2 Changelog
Resource Management - Authorization 30.0.0-beta.1 Changelog
Resource Management - Compute 30.0.0-beta.3 Changelog
Resource Management - Event Hubs 30.0.0-beta.1 Changelog
Resource Management - Features 30.0.0-beta.4 Changelog
Resource Management - Key Vault 30.0.0-beta.1 Changelog
Resource Management - Key Vault 30.0.0-beta.2 Changelog
Resource Management - Key Vault 30.0.0-beta.3 Changelog
Resource Management - Links 30.0.0-beta.2 Changelog
Resource Management - Locks 30.0.0-beta.2 Changelog
Resource Management - Managed Applications 30.0.0-beta.2 Changelog
Resource Management - Network 30.0.0-beta.2 Changelog
Resource Management - Network 30.0.0-beta.3 Changelog
Resource Management - Policy 30.0.0-beta.2 Changelog
Resource Management - Purview 1.0.0-beta.1 Changelog
Resource Management - Resources 30.0.0-beta.2 Changelog
Resource Management - SQL 30.0.0-beta.1 Changelog
Resource Management - SQL 30.0.0-beta.2 Changelog
Resource Management - SQL 30.0.0-beta.3 Changelog
Resource Management - Service Bus 30.0.0-beta.1 Changelog
Resource Management - Storage 30.0.0-beta.2 Changelog
Resource Management - Template Specs 1.0.0-beta.1 Changelog
Resource Management - WebPubSub 1.0.0-beta.1 Changelog
Storage - Blobs 12.8.0 Changelog
Features Added
- Includes all features released in 12.8.0-beta.1.
Storage - Files Data Lake 12.7.0 Changelog
Features Added
- Includes all features released in 12.7.0-beta.1.
Storage - Files Shares 12.8.0 Changelog
Features Added
- Includes all features released in 12.8.0-beta.1.
Storage - Queues 12.7.0 Changelog
Features Added
- Added support for service version 2020-10-02.
- With the dropping of support for Node.js versions that are no longer in LTS, the dependency on
@types/node
has been updated to version 12. Read our support policy for more details.
Synapse - Managed Private Endpoints 1.0.0-beta.4 Changelog
Other Changes
- Re-generate with swagger
2020-12-01
Tables 12.1.2 Changelog
Bugs Fixed
- Fix
disableTypeConversion
to also apply for booleans and convert value to string when there is no type metadata. #17385
Latest Releases
View all the latest versions of JavaScript packages here.
Installation Instructions
To install the packages, copy and paste the below into a terminal.
$> npm install @azure-rest/core-client@1.0.0-beta.7
$> npm install @azure/arm-appservice@30.0.0-beta.1
$> npm install @azure/arm-appservice@30.0.0-beta.2
$> npm install @azure/arm-authorization@30.0.0-beta.1
$> npm install @azure/arm-compute@30.0.0-beta.3
$> npm install @azure/arm-eventhub@30.0.0-beta.1
$> npm install @azure/arm-features@30.0.0-beta.4
$> npm install @azure/arm-keyvault@30.0.0-beta.1
$> npm install @azure/arm-keyvault@30.0.0-beta.2
$> npm install @azure/arm-keyvault@30.0.0-beta.3
$> npm install @azure/arm-links@30.0.0-beta.2
$> npm install @azure/arm-locks@30.0.0-beta.2
$> npm install @azure/arm-managedapplications@30.0.0-beta.2
$> npm install @azure/arm-network@30.0.0-beta.2
$> npm install @azure/arm-network@30.0.0-beta.3
$> npm install @azure/arm-policy@30.0.0-beta.2
$> npm install @azure/arm-purview@1.0.0-beta.1
$> npm install @azure/arm-resources@30.0.0-beta.2
$> npm install @azure/arm-resources-subscriptions@1.0.0-beta.1
$> npm install @azure/arm-servicebus@30.0.0-beta.1
$> npm install @azure/arm-sql@30.0.0-beta.1
$> npm install @azure/arm-sql@30.0.0-beta.2
$> npm install @azure/arm-sql@30.0.0-beta.3
$> npm install @azure/arm-storage@30.0.0-beta.2
$> npm install @azure/arm-templatespecs@1.0.0-beta.1
$> npm install @azure/arm-webpubsub@1.0.0-beta.1
$> npm install @azure/attestation@1.0.0
$> npm install @azure/communication-chat@1.1.0-beta.2
$> npm install @azure/communication-chat@1.0.1
$> npm install @azure/container-registry@1.0.0-beta.4
$> npm install @azure/container-registry@1.0.0-beta.5
$> npm install @azure/core-http@2.2.0
$> npm install @azure/core-rest-pipeline@1.3.0
$> npm install @azure/cosmos@3.13.0
$> npm install @azure/cosmos@3.13.1
$> npm install @azure/cosmos@3.14.0
$> npm install @azure/cosmos@3.14.1
$> npm install @azure/data-tables@12.1.2
$> npm install @azure/identity@1.5.2
$> npm install @azure/identity@2.0.0-beta.6
$> npm install @azure/identity-cache-persistence@1.0.0-beta.2
$> npm install @azure/identity-vscode@1.0.0-beta.2
$> npm install @azure/keyvault-certificates@4.4.0-beta.1
$> npm install @azure/keyvault-secrets@4.4.0-beta.1
$> npm install @azure/monitor-query@1.0.0-beta.5
$> npm install @azure/schema-registry@1.0.0-beta.2
$> npm install @azure/schema-registry-avro@1.0.0-beta.2
$> npm install @azure/search-documents@11.3.0-beta.3
$> npm install @azure/search-documents@11.2.1
$> npm install @azure/storage-blob@12.8.0
$> npm install @azure/storage-file-datalake@12.7.0
$> npm install @azure/storage-file-share@12.8.0
$> npm install @azure/storage-queue@12.7.0
$> npm install @azure/synapse-managed-private-endpoints@1.0.0-beta.4
Feedback
If you have a bug or feature request for one of the libraries, please post an issue at the azure-sdk-for-js repository