-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Purview] Release Purview Administration (#24770)
- Loading branch information
1 parent
186c119
commit 051b969
Showing
48 changed files
with
6,700 additions
and
0 deletions.
There are no files selected for viewing
49 changes: 49 additions & 0 deletions
49
...purview/Azure.Analytics.Purview.Administration/Azure.Analytics.Purview.Administration.sln
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
|
||
Microsoft Visual Studio Solution File, Format Version 12.00 | ||
# Visual Studio Version 17 | ||
VisualStudioVersion = 17.0.31806.525 | ||
MinimumVisualStudioVersion = 10.0.40219.1 | ||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Analytics.Purview.Administration", "src\Azure.Analytics.Purview.Administration.csproj", "{B0C276D1-2930-4887-B29A-D1A33E7009A2}" | ||
EndProject | ||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Analytics.Purview.Administration.Tests", "tests\Azure.Analytics.Purview.Administration.Tests.csproj", "{8E9A77AC-792A-4432-8320-ACFD46730401}" | ||
EndProject | ||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.TestFramework", "..\..\core\Azure.Core.TestFramework\src\Azure.Core.TestFramework.csproj", "{ECC730C1-4AEA-420C-916A-66B19B79E4DC}" | ||
EndProject | ||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Test.Stress", "..\..\..\common\Stress\Azure.Test.Stress\Azure.Test.Stress.csproj", "{A4241C1F-A53D-474C-9E4E-075054407E74}" | ||
EndProject | ||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Test.Perf", "..\..\..\common\Perf\Azure.Test.Perf\Azure.Test.Perf.csproj", "{FA8BD3F1-8616-47B6-974C-7576CDF4717E}" | ||
EndProject | ||
Global | ||
GlobalSection(SolutionConfigurationPlatforms) = preSolution | ||
Debug|Any CPU = Debug|Any CPU | ||
Release|Any CPU = Release|Any CPU | ||
EndGlobalSection | ||
GlobalSection(ProjectConfigurationPlatforms) = postSolution | ||
{B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
{B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
{B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
{B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.Build.0 = Release|Any CPU | ||
{8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
{8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
{8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
{8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.Build.0 = Release|Any CPU | ||
{ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
{ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
{ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
{ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.Build.0 = Release|Any CPU | ||
{A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
{A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
{A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
{A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.Build.0 = Release|Any CPU | ||
{FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
{FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
{FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
{FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.Build.0 = Release|Any CPU | ||
EndGlobalSection | ||
GlobalSection(SolutionProperties) = preSolution | ||
HideSolutionNode = FALSE | ||
EndGlobalSection | ||
GlobalSection(ExtensibilityGlobals) = postSolution | ||
SolutionGuid = {B6DFAA14-2473-4BC3-B66B-4421B51AE592} | ||
EndGlobalSection | ||
EndGlobal |
8 changes: 8 additions & 0 deletions
8
sdk/purview/Azure.Analytics.Purview.Administration/CHANGELOG.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Release History | ||
|
||
## 1.0.0-beta.1 (2021-10-19) | ||
|
||
### New Features | ||
|
||
- Initial preview release of the Azure Purview Administration client library for .NET | ||
- Provides operations for Purview Account and MetadataPolicies services |
6 changes: 6 additions & 0 deletions
6
sdk/purview/Azure.Analytics.Purview.Administration/Directory.Build.props
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
<!-- | ||
Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props | ||
--> | ||
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" /> | ||
</Project> |
131 changes: 131 additions & 0 deletions
131
sdk/purview/Azure.Analytics.Purview.Administration/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
# Azure Purview Administration client library for .NET | ||
|
||
Azure Purview Administration contains the Purview Account and Purview MetdataPolicy managed cloud service. | ||
|
||
**Please rely heavily on the [service's documentation][account_product_documentation] and our [protocol client docs][protocol_client_quickstart] to use this library** | ||
|
||
[Source code][source_code] | [Package (NuGet)][client_nuget_package] | [Product documentation][account_product_documentation] | ||
|
||
## Getting started | ||
|
||
### Install the package | ||
|
||
Install the Azure Purview Administration client library for .NET with [NuGet][client_nuget_package]: | ||
|
||
```dotnetcli | ||
dotnet add package Azure.Analysis.Purview.Administration | ||
``` | ||
|
||
### Prerequisites | ||
|
||
- You must have an [Azure subscription][azure_subscription] and a [Purview resource][purview_resource] to use this package. | ||
|
||
### Authenticate the client | ||
|
||
#### Using Azure Active Directory | ||
|
||
This document demonstrates using [DefaultAzureCredential][default_cred_ref] to authenticate via Azure Active Directory. However, any of the credentials offered by the [Azure.Identity][azure_identity] will be accepted. See the [Azure.Identity][azure_identity] documentation for more information about other credentials. | ||
|
||
Once you have chosen and configured your credential, you can create instances of the `PurviewAccountClient`, `PurviewMetadataPolicyClient` or `PurviewMetadataRolesClient`. | ||
|
||
```C# | ||
var credential = new DefaultAzureCredential(); | ||
var accountClient = new PurviewAccountClient(new Url("https://<my-account-name>.purview.azure.com"), credential); | ||
var policyClient = new PurviewMetadataPolicyClient(new Url("https://<my-account-name>.purview.azure.com"), "myCollection", credential); | ||
var roleClient = new PurviewMetadataRolesClient(new Url("https://<my-account-name>.purview.azure.com"), credential); | ||
``` | ||
|
||
## Key concepts | ||
|
||
### Protocol Methods | ||
|
||
Operations exposed by the Purview Account SDK for .NET use *protocol methods* to expose the underlying REST operations. You can learn more about how to use SDK Clients which use protocol methods in our [documentation][protocol_client_quickstart]. | ||
|
||
### Thread safety | ||
|
||
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads. | ||
|
||
### Additional concepts | ||
<!-- CLIENT COMMON BAR --> | ||
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | | ||
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | | ||
[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) | | ||
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | | ||
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) | | ||
[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#mocking) | | ||
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) | ||
<!-- CLIENT COMMON BAR --> | ||
|
||
## Examples | ||
|
||
The following section shows you how to initialize and authenticate your client, then get all of the type definitions in the catalog. | ||
|
||
### Get All Account Type Definitions | ||
|
||
```C# | ||
var credential = new DefaultAzureCredential(); | ||
var client = new PurviewAccountClient(new Uri("https://<my-account-name>.purview.azure.com"), credential); | ||
|
||
var Response response = await client.GetAccountPropertiesAsync(); | ||
var responseDocument = JsonDocument.Parse(response.Content); | ||
Console.WriteLine(responseDocument.RootElement.GetProperty("name")); | ||
``` | ||
|
||
### List All Roles | ||
|
||
```C# | ||
var credential = new DefaultAzureCredential(); | ||
var client = new PurviewMetadataRolesClient(new Uri("https://<my-account-name>.purview.azure.com"), credential); | ||
|
||
AsyncPageable<BinaryData> fetchResponse = client.GetMetadataRolesAsync(new()); | ||
await foreach (BinaryData item in fetchResponse) | ||
{ | ||
JsonElement fetchBodyJson = JsonDocument.Parse(item).RootElement; | ||
Console.WriteLine(fetchBodyJson.GetProperty("id")); | ||
} | ||
``` | ||
|
||
## Troubleshooting | ||
|
||
### Setting up console logging | ||
|
||
The simplest way to see the logs is to enable the console logging. | ||
To create an Azure SDK log listener that outputs messages to console use AzureEventSourceListener.CreateConsoleLogger method. | ||
|
||
```C# | ||
// Setup a listener to monitor logged events. | ||
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(); | ||
``` | ||
|
||
To learn more about other logging mechanisms see [here][azure_core_diagnostics]. | ||
|
||
## Next steps | ||
|
||
This client SDK exposes operations using *protocol methods*, you can learn more about how to use SDK Clients which use protocol methods in our [documentation][protocol_client_quickstart]. | ||
|
||
## Contributing | ||
|
||
See the [CONTRIBUTING.md][contributing] for details on building, testing, and contributing to this library. | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla]. | ||
|
||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. | ||
|
||
<!-- LINKS --> | ||
[source_code]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/purview/Azure.Analytics.Purview.Account/src | ||
[client_nuget_package]: https://www.nuget.org/packages?q=Azure.Analytics.Purview.Account | ||
[account_product_documentation]: https://azure.microsoft.com/services/purview/ | ||
[azure_identity]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity | ||
[protocol_client_quickstart]: https://aka.ms/azsdk/net/protocol/quickstart | ||
[default_cred_ref]: https://docs.microsoft.com/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet | ||
[azure_subscription]: https://azure.microsoft.com/free/dotnet/ | ||
[purview_resource]: https://docs.microsoft.com/azure/purview | ||
[azure_core_diagnostics]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md | ||
[cla]: https://cla.microsoft.com | ||
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ | ||
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ | ||
[coc_contact]: mailto:opencode@microsoft.com | ||
|
||
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fpurview%2FAzure.Analytics.Purview.Catalog%2FREADME.png) |
85 changes: 85 additions & 0 deletions
85
...ytics.Purview.Administration/api/Azure.Analytics.Purview.Administration.netstandard2.0.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
namespace Azure.Analytics.Purview.Administration | ||
{ | ||
public partial class PurviewAccountClient | ||
{ | ||
protected PurviewAccountClient() { } | ||
public PurviewAccountClient(System.Uri endpoint, Azure.Core.TokenCredential credential, Azure.Analytics.Purview.Administration.PurviewAccountClientOptions options = null) { } | ||
public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } } | ||
public virtual Azure.Response GetAccessKeys(Azure.RequestOptions options) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> GetAccessKeysAsync(Azure.RequestOptions options) { throw null; } | ||
public virtual Azure.Response GetAccountProperties(Azure.RequestOptions options) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> GetAccountPropertiesAsync(Azure.RequestOptions options) { throw null; } | ||
public virtual Azure.Analytics.Purview.Administration.PurviewCollection GetCollectionClient(string collectionName) { throw null; } | ||
public virtual Azure.Pageable<System.BinaryData> GetCollections(Azure.RequestOptions options, string skipToken = null) { throw null; } | ||
public virtual Azure.AsyncPageable<System.BinaryData> GetCollectionsAsync(Azure.RequestOptions options, string skipToken = null) { throw null; } | ||
public virtual Azure.Analytics.Purview.Administration.PurviewResourceSetRule GetResourceSetRuleClient() { throw null; } | ||
public virtual Azure.Pageable<System.BinaryData> GetResourceSetRules(Azure.RequestOptions options, string skipToken = null) { throw null; } | ||
public virtual Azure.AsyncPageable<System.BinaryData> GetResourceSetRulesAsync(Azure.RequestOptions options, string skipToken = null) { throw null; } | ||
public virtual Azure.Response RegenerateAccessKey(Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> RegenerateAccessKeyAsync(Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
public virtual Azure.Response UpdateAccountProperties(Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> UpdateAccountPropertiesAsync(Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
} | ||
public partial class PurviewAccountClientOptions : Azure.Core.ClientOptions | ||
{ | ||
public PurviewAccountClientOptions(Azure.Analytics.Purview.Administration.PurviewAccountClientOptions.ServiceVersion version = Azure.Analytics.Purview.Administration.PurviewAccountClientOptions.ServiceVersion.V2019_11_01_preview) { } | ||
public enum ServiceVersion | ||
{ | ||
V2019_11_01_preview = 1, | ||
} | ||
} | ||
public partial class PurviewCollection | ||
{ | ||
protected PurviewCollection() { } | ||
public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } } | ||
public virtual Azure.Response CreateOrUpdateCollection(Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrUpdateCollectionAsync(Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
public virtual Azure.Response DeleteCollection(Azure.RequestOptions options = null) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteCollectionAsync(Azure.RequestOptions options = null) { throw null; } | ||
public virtual Azure.Response GetCollection(Azure.RequestOptions options) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> GetCollectionAsync(Azure.RequestOptions options) { throw null; } | ||
public virtual Azure.Response GetCollectionPath(Azure.RequestOptions options) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> GetCollectionPathAsync(Azure.RequestOptions options) { throw null; } | ||
public virtual Azure.Pageable<System.BinaryData> ListChildCollectionNames(Azure.RequestOptions options, string skipToken = null) { throw null; } | ||
public virtual Azure.AsyncPageable<System.BinaryData> ListChildCollectionNamesAsync(Azure.RequestOptions options, string skipToken = null) { throw null; } | ||
} | ||
public partial class PurviewMetadataClientOptions : Azure.Core.ClientOptions | ||
{ | ||
public PurviewMetadataClientOptions(Azure.Analytics.Purview.Administration.PurviewMetadataClientOptions.ServiceVersion version = Azure.Analytics.Purview.Administration.PurviewMetadataClientOptions.ServiceVersion.V2021_07_01) { } | ||
public enum ServiceVersion | ||
{ | ||
V2021_07_01 = 1, | ||
} | ||
} | ||
public partial class PurviewMetadataPolicyClient | ||
{ | ||
protected PurviewMetadataPolicyClient() { } | ||
public PurviewMetadataPolicyClient(System.Uri endpoint, string collectionName, Azure.Core.TokenCredential credential, Azure.Analytics.Purview.Administration.PurviewMetadataClientOptions options = null) { } | ||
public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } } | ||
public virtual Azure.Pageable<System.BinaryData> GetMetadataPolicies(Azure.RequestOptions options) { throw null; } | ||
public virtual Azure.AsyncPageable<System.BinaryData> GetMetadataPoliciesAsync(Azure.RequestOptions options) { throw null; } | ||
public virtual Azure.Response GetMetadataPolicy(string policyId, Azure.RequestOptions options) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> GetMetadataPolicyAsync(string policyId, Azure.RequestOptions options) { throw null; } | ||
public virtual Azure.Response UpdateMetadataPolicy(string policyId, Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> UpdateMetadataPolicyAsync(string policyId, Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
} | ||
public partial class PurviewMetadataRolesClient | ||
{ | ||
protected PurviewMetadataRolesClient() { } | ||
public PurviewMetadataRolesClient(System.Uri endpoint, Azure.Core.TokenCredential credential, Azure.Analytics.Purview.Administration.PurviewMetadataClientOptions options = null) { } | ||
public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } } | ||
public virtual Azure.Pageable<System.BinaryData> GetMetadataRoles(Azure.RequestOptions options) { throw null; } | ||
public virtual Azure.AsyncPageable<System.BinaryData> GetMetadataRolesAsync(Azure.RequestOptions options) { throw null; } | ||
} | ||
public partial class PurviewResourceSetRule | ||
{ | ||
protected PurviewResourceSetRule() { } | ||
public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } } | ||
public virtual Azure.Response CreateOrUpdateResourceSetRule(Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrUpdateResourceSetRuleAsync(Azure.Core.RequestContent content, Azure.RequestOptions options = null) { throw null; } | ||
public virtual Azure.Response DeleteResourceSetRule(Azure.RequestOptions options = null) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteResourceSetRuleAsync(Azure.RequestOptions options = null) { throw null; } | ||
public virtual Azure.Response GetResourceSetRule(Azure.RequestOptions options) { throw null; } | ||
public virtual System.Threading.Tasks.Task<Azure.Response> GetResourceSetRuleAsync(Azure.RequestOptions options) { throw null; } | ||
} | ||
} |
Oops, something went wrong.