Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MetricsAdvisor] Renamed DataSourceCredential types #22119

Merged
merged 3 commits into from
Jun 24, 2021
Merged

[MetricsAdvisor] Renamed DataSourceCredential types #22119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fc3b24
Updated names
kinelski Jun 23, 2021
5615860
Updated API and changelog
kinelski Jun 23, 2021
09e2b2d
Regenerated code
kinelski Jun 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion sdk/metricsadvisor/Azure.AI.MetricsAdvisor/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@
## 1.0.0-beta.5 (Unreleased)

### Breaking Changes
- The whole `DatasourceCredential` API has been renamed to `DataSourceCredential`. This includes renames in types, methods, and properties.
- The whole `DatasourceCredential` API has been renamed to `DataSourceCredential`. This includes renames in methods, method parameters, and properties.
- Renamed class `DatasourceCredential` to `DataSourceCredentialEntity`.
- Renamed class `DataLakeGen2SharedKeyDatasourceCredential` to `DataSourceDataLakeGen2SharedKey`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ohh cool. Just for my own learning, what was the reason for moving DataSource to the beginning of the types?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't like ending in "Credential" that much because this can get mixed up with credential types in Identity. I'm okay with just appending "CredentialIdentity" to everything, but other languages are taking this approach, so I'm following along for consistency. The reasoning is something like "DataSourceSqlConnectionString" is a "data source's SQL connection string".

In terms of advantage, I can only think of:

  • Types names get shorter (I've heard that DataLakeGen2SharedKeyDataSourceCredential is too long more than once).
  • All credential types get organized in the same place because of alphabetical order.

- Renamed class `ServicePrincipalDatasourceCredential` to `DataSourceServicePrincipal`.
- Renamed class `ServicePrincipalInKeyVaultDatasourceCredential` to `DataSourceServicePrincipalInKeyVault`.
- Renamed class `SqlConnectionStringDatasourceCredential` to `DataSourceSqlConnectionString`.
- Split the method `GetAnomalies` into two different methods: `GetAnomaliesForAlert` and `GetAnomaliesForDetectionConfiguration`.
- Split the method `GetIncidents` into two different methods: `GetIncidentsForAlert` and `GetIncidentsForDetectionConfiguration`.
- `DataFeedIngestionSettings` constructor now takes the required `ingestionStartTime` parameter. For this reason, the property `IngestionStartTime` is not nullable anymore.
Expand Down
74 changes: 37 additions & 37 deletions sdk/metricsadvisor/Azure.AI.MetricsAdvisor/api/Azure.AI.MetricsAdvisor.netstandard2.0.cs
View file
Open in desktop

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions ...AI.MetricsAdvisor/src/Generated/MicrosoftAzureMetricsAdvisorRestAPIOpenAPIV2RestClient.cs
View file
Open in desktop

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

14 changes: 7 additions & 7 deletions ...els/DataSourceCredential.Serialization.cs → ...taSourceCredentialEntity.Serialization.cs
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions .../Generated/Models/DataSourceCredential.cs → ...ated/Models/DataSourceCredentialEntity.cs
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions ...or/Azure.AI.MetricsAdvisor/src/Generated/Models/DataSourceCredentialList.Serialization.cs
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions sdk/metricsadvisor/Azure.AI.MetricsAdvisor/src/Generated/Models/DataSourceCredentialList.cs
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions ...dKeyDataSourceCredential.Serialization.cs → ...rceDataLakeGen2SharedKey.Serialization.cs
View file
Open in desktop

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

2 changes: 1 addition & 1 deletion ...aLakeGen2SharedKeyDataSourceCredential.cs → ...Models/DataSourceDataLakeGen2SharedKey.cs
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions ...ipalDataSourceCredential.Serialization.cs → ...taSourceServicePrincipal.Serialization.cs
View file
Open in desktop

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

2 changes: 1 addition & 1 deletion ...s/ServicePrincipalDataSourceCredential.cs → ...ated/Models/DataSourceServicePrincipal.cs
View file
Open in desktop

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

Loading