-
Notifications
You must be signed in to change notification settings - Fork 945
[aznamespaces] Moving to new folder site, updating readme and autorest #22441
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.
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
Merged
richardpark-msft
merged 9 commits into
Azure:main
from
richardpark-msft:eg-aznamespaces
Feb 28, 2024
Merged
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3fa1d3a
starting the module
8fdd789
Starting migration of the newer EventGrid client into it's own module.
d25ee6b
- Update version of autorest used
2f75056
We were still referencing the old eventgrid package! Everything's bee…
1726748
Remove eng/, it's only for certain packages.
a95ea62
Bringing back the old azeventgrid module contents. It's temporary, bu…
887da25
Applying Charles' suggested changes.
richardpark-msft fec144f
Shuld use 1.18 as our base version, not 1.20.
19535df
Merge branch 'eg-aznamespaces' of github.com:richardpark-msft/azure-s…
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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,51 @@ | ||
| # Release History | ||
|
|
||
| ## 0.4.1 (Unreleased) | ||
|
|
||
| ### Features Added | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| - This module has been moved from it's previous location in `azeventgrid` to this location (`github.com/Azure/azure-sdk-for-go/sdk/messaging/eventgrid/aznamespaces`). | ||
|
|
||
| ### Bugs Fixed | ||
|
|
||
| ### Other Changes | ||
|
|
||
| ## 0.4.0 (2023-11-27) | ||
|
|
||
| ### Features Added | ||
|
|
||
| - New functionality for Event Grid namespaces: | ||
| - Client.PublishCloudEvent can be used to publish a single `messaging.CloudEvent`. | ||
| - Client.RenewCloudEventLocks can extend the lock time for a set of events. | ||
| - Client.ReleaseCloudEvents (via ReleaseCloudEventsOptions.ReleaseDelayInSeconds) can release an event with a | ||
| server-side delay, allowing the message to remain unavailable for a configured period of time. | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| - FailedLockToken, included in the response for settlement functions, has an `Error` field, which contains the data previously | ||
| in `ErrorDescription` and `ErrorCode`. | ||
| - Settlement functions (AcknowledgeCloudEvents, ReleaseCloudEvents, RejectCloudEvents) take lock tokens as a parameter. | ||
|
|
||
| ## 0.3.0 (2023-10-17) | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| - Client constructors that take a `key string` parameter for a credential now require an `*azcore.KeyCredential` or `*azcore.SASCredential`. | ||
|
|
||
| ## 0.2.0 (2023-09-12) | ||
|
|
||
| ### Features Added | ||
|
|
||
| - The publisher client for Event Grid topics has been added as a sub-package under `publisher`. | ||
|
|
||
| ### Other Changes | ||
|
|
||
| - Documentation and examples added for Event Grid namespace client. | ||
|
|
||
| ## 0.1.0 (2023-07-11) | ||
|
|
||
| ### Features Added | ||
|
|
||
| - Initial preview for the Event Grid package for Event Grid Namespaces | ||
This file contains hidden or 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,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) Microsoft Corporation. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or 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,128 @@ | ||
| # Azure Event Grid Namespaces Client Module for Go | ||
|
|
||
| [Azure Event Grid](https://learn.microsoft.com/azure/event-grid/overview) is a highly scalable, fully managed Pub Sub message distribution service that offers flexible message consumption patterns. For more information about Event Grid see: [link](https://learn.microsoft.com/azure/event-grid/overview). | ||
|
|
||
| This client module allows you to publish events and receive events using the [Pull delivery](https://learn.microsoft.com/azure/event-grid/pull-delivery-overview) API. | ||
|
|
||
| > NOTE: This client does not work with Event Grid Basic. Use the [publisher.Client][godoc_publisher_client] in the `publisher` sub-package instead. | ||
|
|
||
| Key links: | ||
| - [Source code][source] | ||
| - [API Reference Documentation][godoc] | ||
| - [Product documentation](https://azure.microsoft.com/services/event-grid/) | ||
| - [Samples][godoc_examples] | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Install the package | ||
|
|
||
| Install the Azure Event Grid Namespaces client module for Go with `go get`: | ||
|
|
||
| ```bash | ||
| go get github.com/Azure/azure-sdk-for-go/sdk/messaging/eventgrid/aznamespaces | ||
| ``` | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Go, version 1.18 or higher | ||
| - An [Azure subscription](https://azure.microsoft.com/free/) | ||
| - An [Event Grid namespace][ms_namespace]. You can create an Event Grid namespace using the [Azure Portal][ms_create_namespace]. | ||
| - An [Event Grid namespace topic][ms_topic]. You can create an Event Grid namespace topic using the [Azure Portal][ms_create_topic]. | ||
|
|
||
| ### Authenticate the client | ||
|
|
||
| Event Grid namespace clients authenticate using a shared key credential. An example of that can be viewed here: [ExampleNewClientWithSharedKeyCredential][godoc_example_newclient]. | ||
|
|
||
| # Key concepts | ||
|
|
||
| An Event Grid namespace is a container for multiple types of resources, including [**namespace topics**][ms_topic]: | ||
| - A [**namespace topic**][ms_topic] contains CloudEvents that you publish, via [Client.PublishCloudEvents][godoc_client_publish]. | ||
| - A [**topic subscription**][ms_subscription], associated with a single topic, can be used to receive events via [Client.ReceiveEvents][godoc_client_receive]. | ||
|
|
||
| Namespaces also offer access using MQTT, although that is not covered in this package. | ||
|
|
||
| # Examples | ||
|
|
||
| Examples for various scenarios can be found on [pkg.go.dev][godoc_examples] or in the example*_test.go files in our GitHub repo for [aznamespaces][source]. | ||
|
|
||
| # Troubleshooting | ||
|
|
||
| ### Logging | ||
|
|
||
| This module uses the classification-based logging implementation in `azcore`. To enable console logging for all SDK modules, set the environment variable `AZURE_SDK_GO_LOGGING` to `all`. | ||
|
|
||
| Use the `azcore/log` package to control log event output. | ||
|
|
||
| ```go | ||
| import ( | ||
| "fmt" | ||
| azlog "github.com/Azure/azure-sdk-for-go/sdk/azcore/log" | ||
| ) | ||
|
|
||
| // print log output to stdout | ||
| azlog.SetListener(func(event azlog.Event, s string) { | ||
| fmt.Printf("[%s] %s\n", event, s) | ||
| }) | ||
| ``` | ||
|
|
||
| # Next steps | ||
|
|
||
| More sample code should go here, along with links out to the appropriate example tests. | ||
|
|
||
| ## Contributing | ||
| For details on contributing to this repository, see the [contributing guide][azure_sdk_for_go_contributing]. | ||
|
|
||
| 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 https://cla.microsoft.com. | ||
|
|
||
| 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](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| ### Additional Helpful Links for Contributors | ||
| Many people all over the world have helped make this project better. You'll want to check out: | ||
|
|
||
| * [What are some good first issues for new contributors to the repo?](https://github.com/azure/azure-sdk-for-go/issues?q=is%3Aopen+is%3Aissue+label%3A%22up+for+grabs%22) | ||
| * [How to build and test your change][azure_sdk_for_go_contributing_developer_guide] | ||
| * [How you can make a change happen!][azure_sdk_for_go_contributing_pull_requests] | ||
| * Frequently Asked Questions (FAQ) and Conceptual Topics in the detailed [Azure SDK for Go wiki](https://github.com/azure/azure-sdk-for-go/wiki). | ||
|
|
||
| <!-- ### Community--> | ||
| ### Reporting security issues and security bugs | ||
|
|
||
| Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) <[email protected]>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue). | ||
|
|
||
| ### License | ||
|
|
||
| Azure SDK for Go is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/template/aztemplate/LICENSE.txt) license. | ||
|
|
||
| <!-- LINKS --> | ||
| [azure_sdk_for_go_contributing]: https://github.com/Azure/azure-sdk-for-go/blob/main/CONTRIBUTING.md | ||
| [azure_sdk_for_go_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-go/blob/main/CONTRIBUTING.md#developer-guide | ||
| [azure_sdk_for_go_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-go/blob/main/CONTRIBUTING.md#pull-requests | ||
| [azure_cli]: https://docs.microsoft.com/cli/azure | ||
| [azure_pattern_circuit_breaker]: https://docs.microsoft.com/azure/architecture/patterns/circuit-breaker | ||
| [azure_pattern_retry]: https://docs.microsoft.com/azure/architecture/patterns/retry | ||
| [azure_portal]: https://portal.azure.com | ||
| [azure_sub]: https://azure.microsoft.com/free/ | ||
| [cloud_shell]: https://docs.microsoft.com/azure/cloud-shell/overview | ||
| [cloud_shell_bash]: https://shell.azure.com/bash | ||
richardpark-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| [source]: https://aka.ms/azsdk/go/namespaces/src | ||
| [godoc]: https://aka.ms/azsdk/go/namespaces/pkg | ||
| [godoc_client]: https://aka.ms/azsdk/go/namespaces/pkg/#Client | ||
richardpark-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| [godoc_client_publish]: https://aka.ms/azsdk/go/namespaces/pkg#Client.PublishCloudEvents | ||
| [godoc_client_receive]: https://aka.ms/azsdk/go/namespaces/pkg#Client.ReceiveCloudEvents | ||
| [godoc_examples]: https://aka.ms/azsdk/go/namespaces/pkg#pkg-examples | ||
| [godoc_example_newclient]: https://aka.ms/azsdk/go/namespaces/pkg#example-NewClientWithSharedKeyCredential | ||
| [godoc_publisher_client]: https://aka.ms/azsdk/go/eventgrid/pkg/#Client | ||
| [ms_pulldelivery]: https://learn.microsoft.com/azure/event-grid/concepts-pull-delivery | ||
richardpark-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| [ms_namespace]: https://learn.microsoft.com/azure/event-grid/concepts-pull-delivery#namespaces | ||
| [ms_topic]: https://learn.microsoft.com/azure/event-grid/concepts-pull-delivery#namespace-topics | ||
| [ms_subscription]: https://learn.microsoft.com/azure/event-grid/concepts-pull-delivery#event-subscriptions | ||
| [ms_create_namespace]: https://learn.microsoft.com/azure/event-grid/create-view-manage-namespaces | ||
| [ms_create_topic]: https://learn.microsoft.com/azure/event-grid/create-view-manage-namespace-topics | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.