Skip to content

Commit

Permalink
[mgmt] deviceregistry release (#32190)
Browse files Browse the repository at this point in the history
  • Loading branch information
kazrael2119 authored Dec 19, 2024
1 parent b057083 commit 340cf3a
Show file tree
Hide file tree
Showing 203 changed files with 12,837 additions and 6,756 deletions.
41 changes: 27 additions & 14 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

195 changes: 188 additions & 7 deletions sdk/deviceregistry/arm-deviceregistry/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,196 @@
# Release History

## 1.0.0-beta.2 (Unreleased)


## 1.0.0-beta.2 (2024-12-12)
Compared with version 1.0.0-beta.1

### Features Added

### Breaking Changes
- Added operation group BillingContainersOperations
- Added operation group DiscoveredAssetEndpointProfilesOperations
- Added operation group DiscoveredAssetsOperations
- Added operation group SchemaRegistriesOperations
- Added operation group SchemasOperations
- Added operation group SchemaVersionsOperations
- Added operation AssetEndpointProfilesOperations.createOrReplace
- Added operation AssetEndpointProfilesOperations.delete
- Added operation AssetEndpointProfilesOperations.update
- Added operation AssetsOperations.createOrReplace
- Added operation AssetsOperations.delete
- Added operation AssetsOperations.update
- Added Interface AssetEndpointProfileStatus
- Added Interface AssetEndpointProfileStatusError
- Added Interface AssetStatusDataset
- Added Interface AssetStatusEvent
- Added Interface Authentication
- Added Interface BillingContainer
- Added Interface BillingContainerProperties
- Added Interface BillingContainersGetOptionalParams
- Added Interface BillingContainersListBySubscriptionOptionalParams
- Added Interface DataPointBase
- Added Interface Dataset
- Added Interface DiscoveredAsset
- Added Interface DiscoveredAssetEndpointProfile
- Added Interface DiscoveredAssetEndpointProfileProperties
- Added Interface DiscoveredAssetEndpointProfilesCreateOrReplaceOptionalParams
- Added Interface DiscoveredAssetEndpointProfilesDeleteOptionalParams
- Added Interface DiscoveredAssetEndpointProfilesGetOptionalParams
- Added Interface DiscoveredAssetEndpointProfilesListByResourceGroupOptionalParams
- Added Interface DiscoveredAssetEndpointProfilesListBySubscriptionOptionalParams
- Added Interface DiscoveredAssetEndpointProfilesUpdateOptionalParams
- Added Interface DiscoveredAssetEndpointProfileUpdate
- Added Interface DiscoveredAssetEndpointProfileUpdateProperties
- Added Interface DiscoveredAssetProperties
- Added Interface DiscoveredAssetsCreateOrReplaceOptionalParams
- Added Interface DiscoveredAssetsDeleteOptionalParams
- Added Interface DiscoveredAssetsGetOptionalParams
- Added Interface DiscoveredAssetsListByResourceGroupOptionalParams
- Added Interface DiscoveredAssetsListBySubscriptionOptionalParams
- Added Interface DiscoveredAssetsUpdateOptionalParams
- Added Interface DiscoveredAssetUpdate
- Added Interface DiscoveredAssetUpdateProperties
- Added Interface DiscoveredDataPoint
- Added Interface DiscoveredDataset
- Added Interface DiscoveredEvent
- Added Interface EventBase
- Added Interface MessageSchemaReference
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface ProxyResource
- Added Interface RestorePollerOptions
- Added Interface Schema
- Added Interface SchemaProperties
- Added Interface SchemaRegistriesCreateOrReplaceOptionalParams
- Added Interface SchemaRegistriesDeleteOptionalParams
- Added Interface SchemaRegistriesGetOptionalParams
- Added Interface SchemaRegistriesListByResourceGroupOptionalParams
- Added Interface SchemaRegistriesListBySubscriptionOptionalParams
- Added Interface SchemaRegistriesUpdateOptionalParams
- Added Interface SchemaRegistry
- Added Interface SchemaRegistryProperties
- Added Interface SchemaRegistryUpdate
- Added Interface SchemaRegistryUpdateProperties
- Added Interface SchemasCreateOrReplaceOptionalParams
- Added Interface SchemasDeleteOptionalParams
- Added Interface SchemasGetOptionalParams
- Added Interface SchemasListBySchemaRegistryOptionalParams
- Added Interface SchemaVersion
- Added Interface SchemaVersionProperties
- Added Interface SchemaVersionsCreateOrReplaceOptionalParams
- Added Interface SchemaVersionsDeleteOptionalParams
- Added Interface SchemaVersionsGetOptionalParams
- Added Interface SchemaVersionsListBySchemaOptionalParams
- Added Interface SystemAssignedServiceIdentity
- Added Interface Topic
- Added Type Alias AuthenticationMethod
- Added Type Alias ContinuablePage
- Added Type Alias DataPointObservabilityMode
- Added Type Alias EventObservabilityMode
- Added Type Alias Format
- Added Type Alias SchemaType
- Added Type Alias SystemAssignedServiceIdentityType
- Added Type Alias TopicRetainType
- Interface AssetEndpointProfileProperties has a new optional parameter authentication
- Interface AssetEndpointProfileProperties has a new optional parameter discoveredAssetEndpointProfileRef
- Interface AssetEndpointProfileProperties has a new optional parameter status
- Interface AssetEndpointProfileUpdateProperties has a new optional parameter authentication
- Interface AssetEndpointProfileUpdateProperties has a new optional parameter endpointProfileType
- Interface AssetProperties has a new optional parameter datasets
- Interface AssetProperties has a new optional parameter defaultDatasetsConfiguration
- Interface AssetProperties has a new optional parameter defaultTopic
- Interface AssetProperties has a new optional parameter discoveredAssetRefs
- Interface AssetStatus has a new optional parameter datasets
- Interface AssetStatus has a new optional parameter events
- Interface AssetUpdateProperties has a new optional parameter datasets
- Interface AssetUpdateProperties has a new optional parameter defaultDatasetsConfiguration
- Interface AssetUpdateProperties has a new optional parameter defaultTopic
- Added Enum KnownAuthenticationMethod
- Added Enum KnownDataPointObservabilityMode
- Added Enum KnownEventObservabilityMode
- Added Enum KnownFormat
- Added Enum KnownSchemaType
- Added Enum KnownSystemAssignedServiceIdentityType
- Added Enum KnownTopicRetainType
- Added Enum KnownVersions
- Enum KnownOrigin has a new value "user,system"
- Enum KnownOrigin has a new value system
- Enum KnownOrigin has a new value user
- Enum KnownProvisioningState has a new value Deleting
- Added function restorePoller

### Bugs Fixed

### Other Changes
### Breaking Changes

- Removed operation AssetEndpointProfiles.beginCreateOrReplace
- Removed operation AssetEndpointProfiles.beginCreateOrReplaceAndWait
- Removed operation AssetEndpointProfiles.beginDelete
- Removed operation AssetEndpointProfiles.beginDeleteAndWait
- Removed operation AssetEndpointProfiles.beginUpdate
- Removed operation AssetEndpointProfiles.beginUpdateAndWait
- Removed operation Assets.beginCreateOrReplace
- Removed operation Assets.beginCreateOrReplaceAndWait
- Removed operation Assets.beginDelete
- Removed operation Assets.beginDeleteAndWait
- Removed operation Assets.beginUpdate
- Removed operation Assets.beginUpdateAndWait
- Class DeviceRegistryManagementClient has a new signature
- Interface AssetEndpointProfileProperties no longer has parameter transportAuthentication
- Interface AssetEndpointProfileProperties no longer has parameter userAuthentication
- Interface AssetEndpointProfilesCreateOrReplaceOptionalParams no longer has parameter resumeFrom
- Interface AssetEndpointProfilesDeleteOptionalParams no longer has parameter resumeFrom
- Interface AssetEndpointProfilesUpdateOptionalParams no longer has parameter resumeFrom
- Interface AssetEndpointProfileUpdateProperties no longer has parameter transportAuthentication
- Interface AssetEndpointProfileUpdateProperties no longer has parameter userAuthentication
- Interface AssetProperties no longer has parameter assetEndpointProfileUri
- Interface AssetProperties no longer has parameter assetType
- Interface AssetProperties no longer has parameter dataPoints
- Interface AssetProperties no longer has parameter defaultDataPointsConfiguration
- Interface AssetsCreateOrReplaceOptionalParams no longer has parameter resumeFrom
- Interface AssetsDeleteOptionalParams no longer has parameter resumeFrom
- Interface AssetsUpdateOptionalParams no longer has parameter resumeFrom
- Interface AssetUpdateProperties no longer has parameter assetType
- Interface AssetUpdateProperties no longer has parameter dataPoints
- Interface AssetUpdateProperties no longer has parameter defaultDataPointsConfiguration
- Interface DataPoint no longer has parameter capabilityId
- Interface DeviceRegistryManagementClientOptionalParams no longer has parameter $host
- Interface DeviceRegistryManagementClientOptionalParams no longer has parameter endpoint
- Interface Event_2 no longer has parameter capabilityId
- Interface UsernamePasswordCredentials no longer has parameter passwordReference
- Interface UsernamePasswordCredentials no longer has parameter usernameReference
- Interface X509Credentials no longer has parameter certificateReference
- Interface AssetEndpointProfileProperties has a new required parameter endpointProfileType
- Interface AssetProperties has a new required parameter assetEndpointProfileRef
- Interface UsernamePasswordCredentials has a new required parameter passwordSecretName
- Interface UsernamePasswordCredentials has a new required parameter usernameSecretName
- Interface X509Credentials has a new required parameter certificateSecretName
- Type of parameter tags of interface AssetEndpointProfileUpdate is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Type of parameter attributes of interface AssetProperties is changed from {
[propertyName: string]: any;
} to Record<string, any>
- Type of parameter tags of interface AssetUpdate is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Type of parameter attributes of interface AssetUpdateProperties is changed from {
[propertyName: string]: any;
} to Record<string, any>
- Type of parameter observabilityMode of interface DataPoint is changed from DataPointsObservabilityMode to DataPointObservabilityMode
- Type of parameter info of interface ErrorAdditionalInfo is changed from Record<string, unknown> to Record<string, any>
- Type of parameter observabilityMode of interface Event_2 is changed from EventsObservabilityMode to EventObservabilityMode
- Type of parameter tags of interface TrackedResource is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Class DeviceRegistryManagementClient no longer has parameter $host
- Class DeviceRegistryManagementClient no longer has parameter apiVersion
- Class DeviceRegistryManagementClient no longer has parameter subscriptionId
- Removed Enum KnownDataPointsObservabilityMode
- Removed Enum KnownEventsObservabilityMode
- Removed Enum KnownUserAuthenticationMode
- Enum KnownOrigin no longer has value System
- Enum KnownOrigin no longer has value User
- Enum KnownOrigin no longer has value UserSystem
- Removed function getContinuationToken


## 1.0.0-beta.1 (2024-04-15)

The package of @azure/arm-deviceregistry is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).
19 changes: 8 additions & 11 deletions sdk/deviceregistry/arm-deviceregistry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f

Microsoft.DeviceRegistry Resource Provider management API.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceregistry/arm-deviceregistry) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-deviceregistry) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-deviceregistry?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
Key links:

- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceregistry/arm-deviceregistry)
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-deviceregistry)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-deviceregistry?view=azure-node-preview)
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceregistry/arm-deviceregistry/samples)

## Getting started

Expand Down Expand Up @@ -43,8 +45,7 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure DeviceRegistryManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
You will also need to **register a new AAD application and grant access to Azure DeviceRegistry** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

Expand Down Expand Up @@ -89,7 +90,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur

## Next steps

Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library.
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceregistry/arm-deviceregistry/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -99,10 +100,6 @@ If you'd like to contribute to this library, please read the [contributing guide

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

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fdeviceregistry%2Farm-deviceregistry%2FREADME.png)

[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
Expand Down
8 changes: 0 additions & 8 deletions sdk/deviceregistry/arm-deviceregistry/_meta.json

This file was deleted.

6 changes: 3 additions & 3 deletions sdk/deviceregistry/arm-deviceregistry/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
"mainEntryPointFilePath": "dist/esm/index.d.ts",
"docModel": {
"enabled": true
},
Expand All @@ -11,7 +11,7 @@
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/arm-deviceregistry.d.ts"
"publicTrimmedFilePath": "dist/arm-deviceregistry.d.ts"
},
"messages": {
"tsdocMessageReporting": {
Expand All @@ -28,4 +28,4 @@
}
}
}
}
}
2 changes: 1 addition & 1 deletion sdk/deviceregistry/arm-deviceregistry/assets.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "js",
"TagPrefix": "js/deviceregistry/arm-deviceregistry",
"Tag": "js/deviceregistry/arm-deviceregistry_e400d2d01c"
"Tag": "js/deviceregistry/arm-deviceregistry_efa8d0494f"
}
17 changes: 17 additions & 0 deletions sdk/deviceregistry/arm-deviceregistry/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import azsdkEslint from "@azure/eslint-plugin-azure-sdk";

export default [
...azsdkEslint.configs.recommended,
{
rules: {
"@azure/azure-sdk/ts-modules-only-named": "warn",
"@azure/azure-sdk/ts-apiextractor-json-types": "warn",
"@azure/azure-sdk/ts-package-json-types": "warn",
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"@azure/azure-sdk/ts-package-json-module": "off",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn",
},
},
];
Loading

0 comments on commit 340cf3a

Please sign in to comment.