azure-sdk-for-js

4.1.0 (2024-08-07)

Features Added

• Vector Search: This feature introduces vector indexes, vector embedding policy and vector queries to enable vector similarity search in JS SDK. docs
• All versions and deletes mode in change feed: The All versions and deletes mode is added in change feed mode which captures every version and every change (create, update, and delete) made to items. docs
• Bypassing integrated cache: The option to bypass integrated cache is now available in RequestOptions. docs
• Computed Properties: Support for adding Computed Properties in items is added. docs
• Composite Indexing: The JS SDK now supports including composite indexes in the indexing policy, improving query performance on multiple fields. docs
• Correlated Activity Id: Correlated Activity Id is added in header of every query request on Items. This helps in troubleshooting by linking all requests for a query that involves multiple server interactions and partitions. Correlated Activity Id can be accessed through query response headers or response.correlatedActivityId.
• Split proof Bulk API: Earlier, whenever Bulk API encountered a partition split during processing, it would return an error message. Now, JS SDK ensures that the Bulk API is resistant to partition split. #18682
• Improved samples: The samples have been updated in this release, now organized into two folders: v3 for features up to the v3 release, and v4 for features up to the v4 release.
• Added support for MakeList and MakeSet query aggregators

Vector Search

• The following sample shows how to create a container with vector embedding and indexing policies.

// define vector indexing policy
const vectorEmbeddingPolicy = {
  vectorEmbeddings: [
    {
      path: "/vector1",
      dataType: VectorEmbeddingDataType.UInt8,
      dimensions: 1000,
      distanceFunction: VectorEmbeddingDistanceFunction.Euclidean,
    },
    {
      path: "/vector2",
      dataType: VectorEmbeddingDataType.Int8,
      dimensions: 200,
      distanceFunction: VectorEmbeddingDistanceFunction.DotProduct,
    },
    {
      path: "/vector3",
      dataType: VectorEmbeddingDataType.UInt8,
      dimensions: 400,
      distanceFunction: VectorEmbeddingDistanceFunction.Cosine,
    },
  ],
};

// add vector indexes in Indexing Policy
const indexingPolicy = {
  automatic: true,
  indexingMode: "consistent",
  vectorIndexes: [
    { path: "/vector1", type: VectorIndexType.Flat },
    { path: "/vector2", type: VectorIndexType.QuantizedFlat },
    { path: "/vector3", type: VectorIndexType.DiskANN },
  ],
};

// define and create container with vector Embedding Policy
const containerDefinition = {
  id: containerId,
  partitionKey: { paths: ["/id"] },
  indexingPolicy: indexingPolicy,
  vectorEmbeddingPolicy: vectorEmbeddingPolicy,
};
await database.containers.createIfNotExists(containerDefinition);

• Vector Search queries without TOP or LIMIT+OFFSET are blocked by default, with an option to disable this check using allowUnboundedNonStreamingQueries in query FeedOptions. Also added an internal buffer size check to prevent excessive memory consumption, throwing errors if the buffer size exceeds the default. The max buffer size can be increased using the vectorSearchBufferSize option from query FeedOptions.

Change Feed - All versions and deletes mode

• The AllVersionsAndDeletes mode is only supported with ChangeFeedStartFrom.Now and ChangeFeedStartFrom.Continuation.
• To read from the change feed in all versions and deletes mode, include changeFeedMode in changeFeedIteratorOptions:

    const changeFeedIteratorOptions: ChangeFeedIteratorOptions = {
      maxItemCount: 5,
      changeFeedStartFrom: ChangeFeedStartFrom.Now(),
      changeFeedMode: ChangeFeedMode.AllVersionsAndDeletes,
    };
    const iterator = container.items.getChangeFeedIterator(changeFeedIteratorOptions);

Bypassing Integrated Cache

• Here is a sample showing how to enable bypassIntegratedCache in RequestOptions.

  const options: RequestOptions = {bypassIntegratedCache: true};
  const response = await container.item("1").read(options);

Computed Properties

• The following snippet configures computed properties for a container:

    const computedProperties: ComputedProperty[] = [{
      name: "lowerLastName",
      query:
        "SELECT VALUE LOWER(IS_DEFINED(c.lastName) ? c.lastName : c.parents[0].familyName) FROM c",
    },];
    const { resource: containerdef } = await database.containers.createIfNotExists({
      id: containerName,
      computedProperties: computedProperties,
      indexingPolicy: indexingPolicy,
    });
    const container: Container = database.container(containerdef.id);

Composite Indexing

• Here's a sample of adding composite indexes for a container:

    const containerDefinition: ContainerDefinition = {
      id: "containerWithCompositeIndexingPolicy",
      indexingPolicy: {
        automatic: true,
        indexingMode: IndexingMode.consistent,
        includedPaths: [
          {
            path: "/*",
          },
        ],
        excludedPaths: [],
        compositeIndexes: [
          [
            { path: "/key", order: "ascending" },
            { path: "/field", order: "ascending" },
          ],
        ],
      },
    };
    await database.containers.create(containerDefinition);

• Added support for passing a custom HttpClient when constructing a CosmosClient.

Breaking Changes

Dropped Support for TypeScript 4.1

• We have opted to discontinue support for TypeScript version 4.1. Consequently, the minimum supported TypeScript version has been elevated to 4.2. Kindly ensure that your environment is promptly updated to align with these changes.

Bugs Fixed

• Fix Bulk operations(Read, Delete, and Patch) failing due to wrong format of partition key in non-partitioned container.

2.1.0 (2024-07-15)

Features Added

• Added operation group ManagedEnvironmentUsages
• Added operation group Usages
• Added operation Jobs.getDetector
• Added operation Jobs.listDetectors
• Added operation Jobs.proxyGet
• Added Interface BlobStorageTokenStore
• Added Interface EncryptionSettings
• Added Interface GetCustomDomainVerificationIdOptionalParams
• Added Interface IngressPortMapping
• Added Interface JobsGetDetectorOptionalParams
• Added Interface JobsListDetectorsNextOptionalParams
• Added Interface JobsListDetectorsOptionalParams
• Added Interface JobsProxyGetOptionalParams
• Added Interface ListUsagesResult
• Added Interface ManagedEnvironmentPropertiesPeerTrafficConfiguration
• Added Interface ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption
• Added Interface ManagedEnvironmentUsagesListNextOptionalParams
• Added Interface ManagedEnvironmentUsagesListOptionalParams
• Added Interface TokenStore
• Added Interface Usage
• Added Interface UsageName
• Added Interface UsagesListNextOptionalParams
• Added Interface UsagesListOptionalParams
• Added Type Alias GetCustomDomainVerificationIdResponse
• Added Type Alias JobsGetDetectorResponse
• Added Type Alias JobsListDetectorsNextResponse
• Added Type Alias JobsListDetectorsResponse
• Added Type Alias JobsProxyGetResponse
• Added Type Alias ManagedEnvironmentUsagesListNextResponse
• Added Type Alias ManagedEnvironmentUsagesListResponse
• Added Type Alias UsagesListNextResponse
• Added Type Alias UsagesListResponse
• Interface AuthConfig has a new optional parameter encryptionSettings
• Interface AvailableWorkloadProfileProperties has a new optional parameter gpus
• Interface Ingress has a new optional parameter additionalPortMappings
• Interface Login has a new optional parameter tokenStore
• Interface ManagedEnvironment has a new optional parameter peerTrafficConfiguration

1.0.0-beta.2 (2024-07-26)

Features Added

• disable hierarchy api subpath export and issue fix.

1.0.0-beta.1 (2024-07-22)

Features Added

Initial release of the Azure Compute Fleet package

1.0.0-beta.2 (2024-07-30)

Features Added

• disable hierarchy api subpath export and issue fix.

33.3.0 (2024-07-17)

Features Added

• Added operation InboundSecurityRuleOperations.get
• Added Interface ExpressRoutePortAuthorizationsDeleteHeaders
• Added Interface ExpressRoutePortsDeleteHeaders
• Added Interface InboundSecurityRuleGetOptionalParams
• Added Interface RouteFilterRulesDeleteHeaders
• Added Interface RouteFiltersDeleteHeaders
• Added Type Alias InboundSecurityRuleGetResponse
• Added Type Alias ProbeNoHealthyBackendsBehavior
• Interface BastionHost has a new optional parameter enableSessionRecording
• Interface ExpressRouteCircuitAuthorization has a new optional parameter connectionResourceUri
• Interface ExpressRouteCrossConnectionsListOptionalParams has a new optional parameter filter
• Interface FlowLog has a new optional parameter identity
• Interface FlowLogInformation has a new optional parameter identity
• Interface Probe has a new optional parameter noHealthyBackendsBehavior
• Interface ServiceEndpointPropertiesFormat has a new optional parameter networkIdentifier
• Interface VirtualNetworkGateway has a new optional parameter identity
• Added Enum KnownProbeNoHealthyBackendsBehavior
• Enum KnownBastionHostSkuName has a new value Premium

1.0.0-beta.1 (2024-07-26)

Features Added

The package of @azure/arm-servicefabricmanagedclusters is using our next generation design principles. To learn more, please refer to our documentation Quick Start.

1.0.0-beta.1 (2024-07-26)

Features Added

The package of @azure/arm-redhatopenshift is using our next generation design principles. To learn more, please refer to our documentation Quick Start.

4.0.0-beta.3 (2024-07-18)

Compared with version 3.0.0

Features Added

• Added operation group ExtensionMetadata
• Added operation group Gateways
• Added operation group Licenses
• Added operation group MachineRunCommands
• Added operation group NetworkProfileOperations
• Added operation group NetworkSecurityPerimeterConfigurations
• Added operation group SettingsOperations
• Added operation Machines.beginAssessPatches
• Added operation Machines.beginAssessPatchesAndWait
• Added operation Machines.beginInstallPatches
• Added operation Machines.beginInstallPatchesAndWait
• Added Interface AccessRule
• Added Interface AgentConfiguration
• Added Interface AgentUpgrade
• Added Interface AgentVersion
• Added Interface AgentVersionsList
• Added Interface AvailablePatchCountByClassification
• Added Interface CloudMetadata
• Added Interface ConfigurationExtension
• Added Interface ErrorDetailAutoGenerated
• Added Interface ErrorResponseAutoGenerated
• Added Interface EsuKey
• Added Interface ExtensionMetadataGetOptionalParams
• Added Interface ExtensionMetadataListOptionalParams
• Added Interface ExtensionsResourceStatus
• Added Interface ExtensionValue
• Added Interface ExtensionValueListResult
• Added Interface Gateway
• Added Interface GatewaysCreateOrUpdateHeaders
• Added Interface GatewaysCreateOrUpdateOptionalParams
• Added Interface GatewaysDeleteHeaders
• Added Interface GatewaysDeleteOptionalParams
• Added Interface GatewaysGetOptionalParams
• Added Interface GatewaysListByResourceGroupNextOptionalParams
• Added Interface GatewaysListByResourceGroupOptionalParams
• Added Interface GatewaysListBySubscriptionNextOptionalParams
• Added Interface GatewaysListBySubscriptionOptionalParams
• Added Interface GatewaysListResult
• Added Interface GatewaysUpdateOptionalParams
• Added Interface GatewayUpdate
• Added Interface HybridComputeManagementClientUpgradeExtensionsHeaders
• Added Interface HybridComputePrivateLinkScope
• Added Interface HybridIdentityMetadata
• Added Interface HybridIdentityMetadataList
• Added Interface IpAddress
• Added Interface KeyDetails
• Added Interface KeyProperties
• Added Interface License
• Added Interface LicenseDetails
• Added Interface LicenseProfile
• Added Interface LicenseProfileArmEsuProperties
• Added Interface LicenseProfileArmEsuPropertiesWithoutAssignedLicense
• Added Interface LicenseProfileMachineInstanceView
• Added Interface LicenseProfileMachineInstanceViewEsuProperties
• Added Interface LicenseProfilesListResult
• Added Interface LicenseProfileStorageModelEsuProperties
• Added Interface LicenseProfileUpdate
• Added Interface LicensesCreateOrUpdateOptionalParams
• Added Interface LicensesDeleteOptionalParams
• Added Interface LicensesGetOptionalParams
• Added Interface LicensesListByResourceGroupNextOptionalParams
• Added Interface LicensesListByResourceGroupOptionalParams
• Added Interface LicensesListBySubscriptionNextOptionalParams
• Added Interface LicensesListBySubscriptionOptionalParams
• Added Interface LicensesListResult
• Added Interface LicensesUpdateOptionalParams
• Added Interface LicenseUpdate
• Added Interface LinuxParameters
• Added Interface Machine
• Added Interface MachineAssessPatchesResult
• Added Interface MachineExtension
• Added Interface MachineExtensionsDeleteHeaders
• Added Interface MachineExtensionsUpdateHeaders
• Added Interface MachineExtensionUpdate
• Added Interface MachineInstallPatchesParameters
• Added Interface MachineInstallPatchesResult
• Added Interface MachineRunCommand
• Added Interface MachineRunCommandInstanceView
• Added Interface MachineRunCommandsCreateOrUpdateHeaders
• Added Interface MachineRunCommandsCreateOrUpdateOptionalParams
• Added Interface MachineRunCommandScriptSource
• Added Interface MachineRunCommandsDeleteHeaders
• Added Interface MachineRunCommandsDeleteOptionalParams
• Added Interface MachineRunCommandsGetOptionalParams
• Added Interface MachineRunCommandsListNextOptionalParams
• Added Interface MachineRunCommandsListOptionalParams
• Added Interface MachineRunCommandsListResult
• Added Interface MachineRunCommandUpdate
• Added Interface MachinesAssessPatchesHeaders
• Added Interface MachinesAssessPatchesOptionalParams
• Added Interface MachinesInstallPatchesHeaders
• Added Interface MachinesInstallPatchesOptionalParams
• Added Interface MachineUpdate
• Added Interface NetworkConfiguration
• Added Interface NetworkInterface
• Added Interface NetworkProfile
• Added Interface NetworkProfileGetOptionalParams
• Added Interface NetworkSecurityPerimeter
• Added Interface NetworkSecurityPerimeterConfiguration
• Added Interface NetworkSecurityPerimeterConfigurationListResult
• Added Interface NetworkSecurityPerimeterConfigurationsGetByPrivateLinkScopeOptionalParams
• Added Interface NetworkSecurityPerimeterConfigurationsListByPrivateLinkScopeNextOptionalParams
• Added Interface NetworkSecurityPerimeterConfigurationsListByPrivateLinkScopeOptionalParams
• Added Interface NetworkSecurityPerimeterConfigurationsReconcileForPrivateLinkScopeHeaders
• Added Interface NetworkSecurityPerimeterConfigurationsReconcileForPrivateLinkScopeOptionalParams
• Added Interface NetworkSecurityPerimeterProfile
• Added Interface OSProfileLinuxConfiguration
• Added Interface OSProfileWindowsConfiguration
• Added Interface PatchSettingsStatus
• Added Interface PrivateEndpointConnection
• Added Interface PrivateEndpointConnectionDataModel
• Added Interface PrivateEndpointConnectionsDeleteHeaders
• Added Interface PrivateLinkResource
• Added Interface PrivateLinkScopesDeleteHeaders
• Added Interface ProductFeature
• Added Interface ProductFeatureUpdate
• Added Interface ProvisioningIssue
• Added Interface ProxyResource
• Added Interface ProxyResourceAutoGenerated
• Added Interface ResourceAssociation
• Added Interface ResourceAutoGenerated
• Added Interface RunCommandInputParameter
• Added Interface RunCommandManagedIdentity
• Added Interface ServiceStatus
• Added Interface ServiceStatuses
• Added Interface Settings
• Added Interface SettingsGetOptionalParams
• Added Interface SettingsPatchOptionalParams
• Added Interface SettingsUpdateOptionalParams
• Added Interface Subnet
• Added Interface TrackedResource
• Added Interface TrackedResourceAutoGenerated
• Added Interface VolumeLicenseDetails
• Added Interface WindowsParameters
• Added Type Alias AccessMode
• Added Type Alias AccessRuleDirection
• Added Type Alias AgentConfigurationMode
• Added Type Alias ArcKindEnum
• Added Type Alias AssessmentModeTypes
• Added Type Alias EsuEligibility
• Added Type Alias EsuKeyState
• Added Type Alias EsuServerType
• Added Type Alias ExecutionState
• Added Type Alias ExtensionMetadataGetResponse
• Added Type Alias ExtensionMetadataListResponse
• Added Type Alias ExtensionsStatusLevelTypes
• Added Type Alias GatewaysCreateOrUpdateResponse
• Added Type Alias GatewaysDeleteResponse
• Added Type Alias GatewaysGetResponse
• Added Type Alias GatewaysListByResourceGroupNextResponse
• Added Type Alias GatewaysListByResourceGroupResponse
• Added Type Alias GatewaysListBySubscriptionNextResponse
• Added Type Alias GatewaysListBySubscriptionResponse
• Added Type Alias GatewaysUpdateResponse
• Added Type Alias GatewayType
• Added Type Alias HotpatchEnablementStatus
• Added Type Alias LastAttemptStatusEnum
• Added Type Alias LicenseAssignmentState
• Added Type Alias LicenseCoreType
• Added Type Alias LicenseEdition
• Added Type Alias LicenseProfileProductType
• Added Type Alias LicenseProfileSubscriptionStatus
• Added Type Alias LicenseProfileSubscriptionStatusUpdate
• Added Type Alias LicensesCreateOrUpdateResponse
• Added Type Alias LicensesGetResponse
• Added Type Alias LicensesListByResourceGroupNextResponse
• Added Type Alias LicensesListByResourceGroupResponse
• Added Type Alias LicensesListBySubscriptionNextResponse
• Added Type Alias LicensesListBySubscriptionResponse
• Added Type Alias LicenseState
• Added Type Alias LicenseStatus
• Added Type Alias LicensesUpdateResponse
• Added Type Alias LicenseTarget
• Added Type Alias LicenseType
• Added Type Alias MachineRunCommandsCreateOrUpdateResponse
• Added Type Alias MachineRunCommandsGetResponse
• Added Type Alias MachineRunCommandsListNextResponse
• Added Type Alias MachineRunCommandsListResponse
• Added Type Alias MachinesAssessPatchesResponse
• Added Type Alias MachinesInstallPatchesResponse
• Added Type Alias NetworkProfileGetResponse
• Added Type Alias NetworkSecurityPerimeterConfigurationsGetByPrivateLinkScopeResponse
• Added Type Alias NetworkSecurityPerimeterConfigurationsListByPrivateLinkScopeNextResponse
• Added Type Alias NetworkSecurityPerimeterConfigurationsListByPrivateLinkScopeResponse
• Added Type Alias NetworkSecurityPerimeterConfigurationsReconcileForPrivateLinkScopeResponse
• Added Type Alias OsType
• Added Type Alias PatchModeTypes
• Added Type Alias PatchOperationStartedBy
• Added Type Alias PatchOperationStatus
• Added Type Alias PatchServiceUsed
• Added Type Alias ProgramYear
• Added Type Alias ProvisioningIssueSeverity
• Added Type Alias ProvisioningIssueType
• Added Type Alias ProvisioningState
• Added Type Alias SettingsGetResponse
• Added Type Alias SettingsPatchResponse
• Added Type Alias SettingsUpdateResponse
• Added Type Alias VMGuestPatchClassificationLinux
• Added Type Alias VMGuestPatchClassificationWindows
• Added Type Alias VMGuestPatchRebootSetting
• Added Type Alias VMGuestPatchRebootStatus
• Interface HybridComputePrivateLinkScopeProperties has a new optional parameter privateEndpointConnections
• Interface MachineExtensionProperties has a new optional parameter enableAutomaticUpgrade
• Interface MachinesListByResourceGroupOptionalParams has a new optional parameter expand
• Interface OperationValue has a new optional parameter isDataAction
• Interface OSProfile has a new optional parameter linuxConfiguration
• Interface OSProfile has a new optional parameter windowsConfiguration
• Interface PrivateEndpointConnectionProperties has a new optional parameter groupIds
• Interface Resource has a new optional parameter systemData
• Added Enum KnownAccessMode
• Added Enum KnownAccessRuleDirection
• Added Enum KnownAgentConfigurationMode
• Added Enum KnownArcKindEnum
• Added Enum KnownAssessmentModeTypes
• Added Enum KnownEsuEligibility
• Added Enum KnownEsuKeyState
• Added Enum KnownEsuServerType
• Added Enum KnownExecutionState
• Added Enum KnownGatewayType
• Added Enum KnownHotpatchEnablementStatus
• Added Enum KnownLastAttemptStatusEnum
• Added Enum KnownLicenseAssignmentState
• Added Enum KnownLicenseCoreType
• Added Enum KnownLicenseEdition
• Added Enum KnownLicenseProfileProductType
• Added Enum KnownLicenseProfileSubscriptionStatus
• Added Enum KnownLicenseProfileSubscriptionStatusUpdate
• Added Enum KnownLicenseState
• Added Enum KnownLicenseStatus
• Added Enum KnownLicenseTarget
• Added Enum KnownLicenseType
• Added Enum KnownOsType
• Added Enum KnownPatchModeTypes
• Added Enum KnownPatchOperationStartedBy
• Added Enum KnownPatchOperationStatus
• Added Enum KnownPatchServiceUsed
• Added Enum KnownProgramYear
• Added Enum KnownProvisioningIssueSeverity
• Added Enum KnownProvisioningIssueType
• Added Enum KnownProvisioningState
• Added Enum KnownVMGuestPatchClassificationLinux
• Added Enum KnownVMGuestPatchClassificationWindows
• Added Enum KnownVMGuestPatchRebootSetting
• Added Enum KnownVMGuestPatchRebootStatus
• Enum KnownPublicNetworkAccessType has a new value SecuredByPerimeter
• Added function getContinuationToken

Breaking Changes

• Interface MachineExtensionsListNextOptionalParams no longer has parameter expand
• Type of parameter protectedSettings of interface MachineExtensionProperties is changed from Record<string, unknown> to {
  [propertyName: string]: any;
  }
• Type of parameter settings of interface MachineExtensionProperties is changed from Record<string, unknown> to {
  [propertyName: string]: any;
  }
• Type of parameter expand of interface MachinesGetOptionalParams is changed from InstanceViewTypes to string
• Removed Enum KnownInstanceViewTypes