The Azure SDK team is pleased to announce our June 2021 client library releases.

GA

  • Cognitive Search

  • Core - AMQP

  • Event Grid

  • Form Recognizer

  • Key Vault - Administration

  • Key Vault - Certificates

  • Key Vault - Keys

  • Key Vault - Secrets

  • Service Bus

  • Storage - Blobs

  • Storage - Files Data Lake

  • Storage - Files Shares

  • Storage - Queues

  • Tables

Updates

  • Core - HTTP

  • Cosmos DB

  • Event Hubs

  • Key Vault - Administration

  • Key Vault - Keys

Beta

  • @azure/iot-modelsrepository

  • App Configuration

  • Attestation

  • Azure Video Analyzer Edge

  • Container Registry

  • Core Rest Pipeline

  • Metrics Advisor

  • Monitor Query

  • farmbeats

  • rest-core-client

Installation Instructions

To install the packages, copy and paste the below into a terminal.

$> npm install @azure-rest/agrifood-farming@1.0.0-beta.1
$> npm install @azure-rest/core-client@1.0.0-beta.3
$> npm install @azure-rest/core-client@1.0.0-beta.4
$> npm install @azure/ai-form-recognizer@3.1.0
$> npm install @azure/ai-metrics-advisor@1.0.0-beta.4
$> npm install @azure/app-configuration@1.2.0-beta.2
$> npm install @azure/attestation@1.0.0-beta.3
$> npm install @azure/attestation@1.0.0-beta.4
$> npm install @azure/container-registry@1.0.0-beta.3
$> npm install @azure/core-amqp@3.0.0
$> npm install @azure/core-http@1.2.5
$> npm install @azure/core-http@1.2.6
$> npm install @azure/core-rest-pipeline@1.1.0-beta.3
$> npm install @azure/cosmos@3.11.4
$> npm install @azure/cosmos@3.11.5
$> npm install @azure/data-tables@12.0.0
$> npm install @azure/event-hubs@5.5.2
$> npm install @azure/eventgrid@4.3.0
$> npm install @azure/iot-modelsrepository@1.0.0-beta.1
$> npm install @azure/keyvault-admin@4.0.0
$> npm install @azure/keyvault-admin@4.0.1
$> npm install @azure/keyvault-certificates@4.2.0
$> npm install @azure/keyvault-keys@4.2.0
$> npm install @azure/keyvault-keys@4.2.1
$> npm install @azure/keyvault-secrets@4.2.0
$> npm install @azure/monitor-query@1.0.0-beta.1
$> npm install @azure/monitor-query@1.0.0-beta.2
$> npm install @azure/search-documents@11.2.0
$> npm install @azure/service-bus@7.2.0
$> npm install @azure/storage-blob@12.6.0
$> npm install @azure/storage-file-datalake@12.5.0
$> npm install @azure/storage-file-share@12.6.0
$> npm install @azure/storage-queue@12.5.0
$> npm install @azure/video-analyzer-edge@1.0.0-beta.2
$> npm install @azure/video-analyzer-edge@1.0.0-beta.1

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

Release highlights

@azure/iot-modelsrepository 1.0.0-beta.1 Changelog

With #14863, this is the first release of the @azure/iot-modelsrepository package. This package contains the ModelsRepositoryClient to talk to the Azure Models Repository service, with initial support for getting models. Additionally, helper functions for working with DTMIs are provided.```

App Configuration 1.2.0-beta.2 Changelog

  • With #15136, if the key of a feature flag(setting with contentType="application/vnd.microsoft.appconfig.ff+json;charset=utf-8") doesn’t start with ".appconfig.featureflag/" (featureFlagPrefix), SDK adds the prefix before sending the request.
  • New design for feature flags and secret references,
  • New types for FeatureFlag and SecretReference - ConfigurationSetting<FeatureFlagValue> and ConfigurationSetting<SecretReferenceValue>
  • Upon using getConfigurationSetting(or add/update), use parseFeatureFlag and parseSecretReference methods to access the properties(to translate ConfigurationSetting into the types above).
  • Helper method isFeatureFlag (and isSecretReference) checks the contentType and return boolean values.

Attestation 1.0.0-beta.3 Changelog

Features Added

Breaking Changes

  • Essentially completely rewritten. All existing functionality has been replaced.
  • Removed policy property on AttestationClient object, because it has been replaced.
  • Removed policy.reset and policy.set, replaced with the resetPolicy and setPolicy methods on the AttestationAdministrationClient.
  • Removed policy.get, replaced with the getPolicy method of the new AttestationAdministrationClient client object.
  • Removed attestation.attestSgxEnclave, attestation.attestOpenEnclave, attestation.attestTpm, and attestation property from attestationClient, replaced with attestSgxEnclave, attestOpenEnclave and attestTpm.
  • Removed metadataConfiguration and signingCertificates properties from attestationClient.
  • Removed metadataConfiguration.get() method, replaced with client.getOpenIdMetadata().
  • Removed signingCertificates.get() method, replaced with client.getAttestationSigners(). The return value for getAttestationSigners() is an array of AttestationSigner objects, each of which has two properties: key_id and certificates. key_id reflects the kid JSON Web Key attribute, and certificates is the decoded x5c attribute in the JSON Web Key.

Attestation 1.0.0-beta.4 Changelog

Features Added

  • The package now contains type definitions compatible with TypeScript versions earlier than v3.6.

Key Bugs Fixed

  • Fixes the location of types definition in package.json

Azure Video Analyzer Edge 1.0.0-beta.2 Changelog

Update the title and description of the package and updates to readme.

Azure Video Analyzer Edge 1.0.0-beta.1 Changelog

Initial release

Cognitive Search 11.2.0 Changelog

The list of changes in 11.2.0 since 11.1.0 & 11.2.0-beta.2 are provided below:

Changes since 11.1.0

  • Added support for Knowledge Store feature through the new SearchIndexerKnowledgeStore in the SearchIndexerSkillset object.
  • The skillsetCounter property in ServiceCounters object has been made optional.
  • Added Support for new datasource adlsgen2. Please refer #14620 for further details.
  • Added Support for new skills such as CustomEntityLookupSkill, DocumentExtractionSkill, etc. Please refer #14620 for further details.

Changes since 11.2.0-beta.2

  • Removed Support for Semantic Search and introduced new properties in SearchOptions, SearchRequest, SearchResult and SearchDocumentsResult objects.
  • Removed Support for normalizers LexicalNormalizer & CustomNormalizer. Please refer #14620 for further details.

Container Registry 1.0.0-beta.3 Changelog

Breaking Changes

  • Split ContentProperties into separate *WriteableProperties types because they can have different properties.
  • Add new type ArtifactManifestPlatform for manifest list in ArtifactManifestProperties. The property has been renamed to relatedArtifacts.
  • Flatten writeableProperties in *Properties types.
  • Rename endpointUrl to endpoint in ContainerRegistryClient.
  • Change known os and arch types to enum so the known values can be used in string comparisons
  • Update *OrderBy values from "timeAsc"/"timeDesc" to "lastUpdatedOnAscending"/"lastUpdatedOnDescending"
  • Rename listTags to listTagProperties and listManifests to listManifestProperties
  • Rename set*Properties function names to update*Properties

Features Added

  • Add authenticationScope properties to ContainerRegistryClientOptions to support national clouds.
  • Add continuationToken to paging response types.

Bug Fixes

  • The expiry time is now retrieved from the ACR refresh token, instead of hard-coded three hours later from Date.now().

Core - AMQP 3.0.0 Changelog

Breaking changes

  • Updates the rhea-promise and rhea dependencies to version 2.x. rhea contains a breaking change that changes deserialization of timestamps from numbers to Date objects.
  • Removes the AsyncLock and defaultLock exports. defaultCancellableLock should be used instead.

Core - HTTP 1.2.5 Changelog

Fixed

  • Delay loading of NO_PROXY environment variable until when request pipeline is being created. This fixes issue 14873
  • Fixed an issue where tracing spans were not setting a status correctly (on success or error) which results in the span status being UNSET. In addition, we will now capture the HTTP status code when a request fails in the tracing span. PR 15061
  • Fix packaging issue PR 15286
  • Improve the sanitizer to handle recursive objects PR 15426

Core - HTTP 1.2.6 Changelog

Key Bugs Fixed

  • Fixed an issue of lost properties when flattening array in deserialization issue 15653
  • Fixed an issue of incorrect minimum version of tslib issue 15697

Core Rest Pipeline 1.1.0-beta.3 Changelog

  • Merged bearerTokenChallengeAuthenticationPolicy into bearerTokenAuthenticationPolicy. This will keep the functionality of bearerTokenAuthenticationPolicy, but also adds the challengeCallbacks feature.

Cosmos DB 3.11.4 Changelog

  • BUGFIX: Correctly failover to new regions when regional DNS has gone offline.

Cosmos DB 3.11.5 Changelog

Features Added

Breaking Changes

Key Bugs Fixed

Fixed

  • BUGFIX: Adds another failover condition.

Event Grid 4.3.0 Changelog

New Features

  • Added new System Event: Microsoft.Storage.BlobInventoryPolicyCompleted

Key Bug Fixes

  • The Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners event was incorrectly listed with the name of Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListener. This has been corrected. When using TypeScript, you will need to replace any calls to isSystemEvent("Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListener") with isSystemEvent("Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners").

Event Hubs 5.5.2 Changelog

Bug fixes

  • Fixes issue #13500 where a TypeError: Cannot read property '_process' of undefined could be thrown in rare cases.

Form Recognizer 3.1.0 Changelog

  • This General Availability (GA) release marks the stability of the changes introduced in package versions 3.1.0-beta.1 through 3.1.0-beta.3.
  • Changed all names including IdDocument to use IdentityDocument instead, for example: BeginRecognizeIdentityDocumentOptions, beginRecognizeIdentityDocuments, and beginRecognizeIdentityDocumentsFromUrl for clarity.
  • Flattened the TextStyle type into the TextAppearance type. Rather than having a style property with its own name and confidence, TextAppearance now has styleName and styleConfidence properties.
  • Removed the FormGenderField type. Any recognized value that was previously produced as a FormGenderField is now returned as a FormStringField instead (the value will remain the same).
  • Renamed the FormCountryField type to FormCountryRegionField, and changed the valueType discriminant property of that type to "countryRegion:.
  • Renamed ReadingOrder and Language to FormReadingOrder and FormLanguage to reduce the chance that these types would collide with other types having the same name from other packages.
  • Removed the KnownStyleName, KnownSelectionMarkState, and KnownKeyValueType enums, as they represent simple string enums. The styleName, state, and valueType properties (respectively) now have strong string-enum types.
  • Added the KnownFormLocale enum to access the well-known possible values of form locales (the locale property of the options parameters for prebuilt model recognition).
  • Migrated to the 2.1 Form Recognizer service endpoint for all REST API calls.

Key Vault - Administration 4.0.0 Changelog

This release marks the general availability of the @azure/keyvault-admin package.

New Features

  • The KeyVaultAccessControlClient provides support for managing role-based access control (RBAC) operations.
  • Both role assignments and custom role definitions are supported with the ability to create, read, update, and delete custom role definitions and assignments.
  • The KeyVaultBackupClient provides support for back up and restore operations for the entire Key Vault Managed HSM instance.
  • Full Managed HSM backup and restore operations are supported.
  • Selective Key Restore from a previous backup is also supported.

Changes since 4.0.0-beta.3:

  • Added the “KeyVault” prefix to all of the Key Vault Admin client operations.
  • Made the AesGcmDecryptParameters authenticationTag required.
  • Collapsed KeyVaultRoleAssignmentPropertiesWithScope to KeyVaultRoleAssignmentProperties.
  • Renamed KeyVaultKeyId to KeyVaultKeyIdentifier.
  • Renamed beginRestore’s blobStorageUri to folderUri.
  • Removed folderName from beginRestore. Now the folder name will be inferred from the folderUri.
  • Renamed beginSelectiveRestore’s blobStorageUri to folderUri.
  • Removed folderName from beginSelectiveRestore. Now the folder name will be inferred from the folderUri.
  • Reordered the parameters of beginSelectiveRestore to keyName, folderUrl, sasToken, [options].
  • Renamed KeyVaultBackupResult’s backupFolderUri to folderUri.
  • Renamed beginSelectiveRestore to beginSelectiveKeyRestore.
  • Renamed KeyVaultBeginSelectiveRestoreOptions to KeyVaultBeginSelectiveKeyRestoreOptions.
  • Renamed KeyVaultSelectiveRestoreOperationState to KeyVaultSelectiveKeyRestoreOperationState.
  • Renamed KeyVaultSelectiveRestoreResult to KeyVaultSelectiveKeyRestoreResult.
  • deleteRoleAssignment and deleteRoleDefinition will no longer throw an exception when the resource no longer exist and return no result.

Key Vault - Administration 4.0.1 Changelog

Bug Fixes

  • Fixed an issue where bundling could fail when importing this library due to an incorrectly set import.

Key Vault - Certificates 4.2.0 Changelog

Bug Fixes

  • Fixed an issue with beginDeleteCertificate and beginRecoverDeletedCertificate in which unknown service errors wouldn’t bubble up properly to the end users.
  • Fixed an issue where importing a certificate incorrectly required a Subject or Subject Alternative Name.
  • Fixed an issue where retrying a failed initial Key Vault request may result in an empty body.
  • Marked ErrorModel as deprecated. It was erroneously exported publicly in 4.1 and should not be used. Please change the type to use CertificateOperationError instead.

Changes since 4.2.0-beta.3

  • Marked ErrorModel as deprecated. It was erroneously exported publicly in 4.1 and should not be used. Please change the type to use CertificateOperationError instead.
  • Fixed a bug with beginDeleteCertificate and beginRecoverDeletedCertificate in which unknown service errors wouldn’t bubble up properly to the end users.
  • Renamed the KeyVaultCertificateId to KeyVaultCertificateIdentifier, and exported a method to parse Key Vault Certificate Ids: parseKeyVaultCertificateIdentifier.

Key Vault - Keys 4.2.0 Changelog

New Features

  • Added support for local cryptography operations. If supported by the key type and algorithm, the CryptographyClient will attempt to perform a cryptography operation locally.
  • Added support for symmetric keys in Managed HSMs including support for AES encryption algorithms to encrypt, decrypt, wrap, and unwrap using symmetric keys.
  • Added support for the 7.2 version of the Key Vault service API.

Bug Fixes

  • Fixed a bug with beginDeleteKey and beginRecoverDeletedKey in which unknown service errors wouldn’t bubble up properly to the end users.
  • Fixed bug with the list operations which were returning misplaced properties. Fixes customer issue: 15353.
  • Fixed an issue where retrying a failed initial Key Vault request may result in an empty body.

Changes since 4.2.0-beta.5:

  • Removed the now obsolete KeyOperationsOptions and replaced it with CryptographyOptions.
  • Introduced in 4.2.0-beta.1 to support additional encryption parameters for AES encryption, we have since moved these parameters outside of the options bag so a separate KeyOperationsOptions is now redundant.
  • Fixed a bug with beginDeleteKey and beginRecoverDeletedKey in which unknown service errors wouldn’t bubble up properly to the end users.
  • Fixed bug with the list operations which were returning misplaced properties. Fixes customer issue: 15353.
  • Exported a method to parse Key Vault Key Ids: parseKeyVaultKeyIdentifier.

Key Vault - Keys 4.2.1 Changelog

Bug Fixes

  • Fixed an issue where bundling could fail when importing this library due to an incorrectly set import.

Key Vault - Secrets 4.2.0 Changelog

New Features

  • Added support for the 7.2 version of the Key Vault service API.

Bug Fixes

  • Fixed a bug with beginDeleteSecret and beginRecoverDeletedSecret in which unknown service errors wouldn’t bubble up properly to the end users.
  • Fixed an issue where retrying a failed initial Key Vault request may result in an empty body.
  • Added a certificateKeyId?: string secret property to use instead of the deprecated keyId?: URL and removed "lib": ["dom"] from tsconfig.json

Changes since 4.2.0-beta.4:

  • Fixed a bug with beginDeleteSecret and beginRecoverDeletedSecret in which unknown service errors wouldn’t bubble up properly to the end users.
  • Renamed the KeyVaultSecretId to KeyVaultSecretIdentifier, and exported a method to parse Key Vault Secret Ids: parseKeyVaultSecretIdentifier.

Metrics Advisor 1.0.0-beta.4 Changelog

New Features

  • Added support for Azure Log Analytics DataFeed source and Azure EventHubs DataFeed source
  • Added datasource credential API support to client
  • Added authentication type support for data feed
  • Added property splitAlertByDimensions to AnomalyAlertConfiguration model
  • Added propertiesvalue and expectedValue to DataPointAnomaly and valueOfRootNode and expectedValueOfRootNode to AnomalyIncident

Breaking Changes

  • Updated Patch types for all update methods
  • Replaced updateSubscriptionKey and updateApiKey into one method updateKey
  • Removed support for HttpRequestDataFeed and ElasticsearchDataFeed source type
  • Removed DataSourceParameter property and serialized DataSourceParameter properties for all datafeed sources into DataFeedSource types
  • Renamed AlertSnoozeCondition to MetricAnomalyAlertSnoozeCondition and MetricAlertConditions to MetricAnomalyAlertConditions

Monitor Query 1.0.0-beta.1 Changelog

  • Initial release of the monitor-query library, allowing you to query Log Analytics Workspaces for logs and metrics.

Monitor Query 1.0.0-beta.2 Changelog

  • Fixing issue using non-commercial clouds, where it wasn’t possible to pass in an endpoint and custom scope, both of which are needed. PR#15705
  • Adding a mitigation for LogsQueryClient.queryLogsBatch() where an invalidly encoded response could lead to no results being surfaced to the user. This should allow for the result to be properly parsed. PR#15718

Service Bus 7.2.0 Changelog

New Features

  • Enable encoding the body of a message to the ‘value’ or ‘sequence’ sections (via AmqpAnnotatedMessage.bodyType). Using this encoding is not required but does allow you to take advantage of native AMQP serialization for supported primitives or sequences.

More information about the AMQP message body type can be found in the AMQP specification: link

  • Improves cancellation support when sending messages or initializing a connection to the service. Resolves #15311 and #13504.

Bug fixes

  • ServiceBusSender could throw an error (TypeError: Cannot read property 'maxMessageSize' of undefined) if a link was being restarted while calling sendMessages(). PR#15409
  • Fixes issue #13500 where a TypeError: Cannot read property '_process' of undefined could be thrown in rare cases.

Storage - Blobs 12.6.0 Changelog

  • Includes all features released in 12.6.0-beta.1.

Storage - Files Data Lake 12.5.0 Changelog

  • Includes all features released in 12.5.0-beta.1.
  • Refined variable names for the Path Soft Delete features introduced from the last beta version: 12.5.0-beta.1.

Storage - Files Shares 12.6.0 Changelog

  • Updated Azure Storage Service API version to 2020-08-04.
  • Fixed bug where ShareFileClient.download, ShareFileClient.downloadToBuffer or ShareFileClient.downloadToFile could corrupt data if source is modified when retrying.

Storage - Queues 12.5.0 Changelog

  • Updated Azure Storage Service API version to 2020-08-04.

Tables 12.0.0 Changelog

  • Added support for generating SAS tokens using an AzureNamedKeyCredential #15564
  • Use @azure/core-auth AzureSASCredendial #15564
  • Fix submit transaction issue 15403 when sending multiple transactions. #15493
  • Fix date serialization on getAccessPolicy and setAccessPolicy Table client methods. #15633

Breaking Changes

  • Use @azure/core-auth AzureNamedKeyCredential #15529
    • Name: “@azure/communication-network-traversal” Version: 1.0.0-beta.1 DisplayName: “@azure/communication-network-traversal” ServiceName: “” VersionType: Beta Hidden: false ChangelogUrl: https://github.com/Azure/azure-sdk-for-js/blob/@azure/communication-network-traversal_1.0.0-beta.1/sdk/communication/communication-network-traversal/CHANGELOG.md#100-beta1-2021-05-24 ChangelogContent: |- The first preview of the Azure Communication Relay Client has the following features:
    • get a Relay Configuration by creating a CommunicationRelayClient

      Added

    • Added CommunicationRelayClient in preview.
    • Added CommunicationRelayClient.getRelayConfiguration in preview.

      Breaking Changes

farmbeats 1.0.0-beta.1 Changelog

  • First release of package, see README.md for details.

rest-core-client 1.0.0-beta.3 Changelog

  • Set Date in query string parameters as ISO string. #15209

rest-core-client 1.0.0-beta.4 Changelog

  • Update @azure/core-rest-pipeline dependency to GA. #15435

Latest Releases

View all the latest versions of JavaScript packages here.