From 3d19c62c750bd1a0d0a1a29b13addaa03dfc859b Mon Sep 17 00:00:00 2001 From: Azad Abbasi Date: Fri, 1 Oct 2021 20:57:02 +0000 Subject: [PATCH] Default Branch update: Update master branch to main. (#2183) * Update master branch to main. * Update horton-e2e.yaml --- .github/CONTRIBUTING.md | 18 +++++++------- .github/ISSUE_TEMPLATE.md | 2 +- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/PULL_REQUEST_TEMPLATE.md | 6 ++--- device_connection_and_reliability_readme.md | 10 ++++---- e2e/test/prerequisites/readme.md | 6 ++--- iothub/device/devdoc/architecture.md | 2 +- iothub/device/samples/readme.md | 24 +++++++++---------- .../IotHubCommunicationException.cs | 2 +- iothub/service/samples/readme.md | 18 +++++++------- iothub/service/src/DigitalTwin/readme.md | 2 +- provisioning/device/samples/readme.md | 6 ++--- .../device/src/CertificateInstaller.cs | 2 +- provisioning/service/samples/readme.md | 10 ++++---- readme.md | 6 ++--- tools/CaptureLogs/readme.md | 4 ++-- tools/diffscripts/README.md | 20 ++++++++-------- tools/diffscripts/diffapi.ps1 | 22 ++++++++--------- vsts/vsts.yaml | 2 +- 19 files changed, 83 insertions(+), 83 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c7f7c515ae..e6f4ddf2d8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -27,13 +27,13 @@ That is definitely something we want to hear about. Please open an issue on gith ## Contribute documentation -For simple markdown files, we accept documentation pull requests submitted against the `master` branch, if it's about existing SDK features. +For simple markdown files, we accept documentation pull requests submitted against the `main` branch, if it's about existing SDK features. If your PR is about future changes or has changes to the comments in the code itself, we'll treat is as a code change (see the next section). ## Contribute code Our SDKs are open-source and we do accept pull-requests if you feel like taking a stab at fixing the bug and maybe adding your name to our commit history :) Please mention any relevant issue number in the pull request description, and follow the contributing guidelines [below](#contributing-guidelines). -Pull-requests for code are to be submitted against the `master` branch. We will review the request and once approved we will be running it in our gated build system. We try to maintain a high bar for code quality and maintainability, we insist on having tests associated with the code, and if necessary, additions/modifications to the requirement documents. +Pull-requests for code are to be submitted against the `main` branch. We will review the request and once approved we will be running it in our gated build system. We try to maintain a high bar for code quality and maintainability, we insist on having tests associated with the code, and if necessary, additions/modifications to the requirement documents. Also, have you signed the [Contribution License Agreement](https://cla.microsoft.com/) ([CLA](https://cla.microsoft.com/))? A friendly bot will remind you about it when you submit your pull-request. @@ -44,9 +44,9 @@ sure your plans and ours are in sync :) Just open an issue on github and tag it 1. If the change affects the public API, extract the updated public API surface and submit a PR for review. Make sure you get a signoff before you move to Step 2. 2. Post API surface approval, follow the below guidelines for contributing code: - a) Follow the steps [here](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/doc/devbox_setup.md) for setting up your development environment. + a) Follow the steps [here](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/doc/devbox_setup.md) for setting up your development environment. - b) Follow the [C# Coding Style](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/doc/coding-style.md). + b) Follow the [C# Coding Style](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/doc/coding-style.md). c) Unit Tests: We write unit tests for any new function or block of application code that impacts the existing behavior of the code. @@ -73,9 +73,9 @@ sure your plans and ours are in sync :) Just open an issue on github and tag it ``` d) E2E Tests: Any new feature or functionality added must have associated end-to-end tests. - 1. Update/ Add the E2E tests [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/master/e2e/test). - 2. In case environmental setup required for the application is changed, update the pre-requisites [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/master/e2e/test/prerequisites). - 3. Run the E2E test suite and ensure that all the tests pass successfully. You can also test against the [CI script](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/jenkins/windows_csharp.cmd) that is used in our gated build system. + 1. Update/ Add the E2E tests [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/main/e2e/test). + 2. In case environmental setup required for the application is changed, update the pre-requisites [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/main/e2e/test/prerequisites). + 3. Run the E2E test suite and ensure that all the tests pass successfully. You can also test against the [CI script](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/jenkins/windows_csharp.cmd) that is used in our gated build system. e) Samples: Add relevant samples to the [Azure IoT Samples for C# Repo](https://github.com/Azure-Samples/azure-iot-samples-csharp). Make sure to add a supporting readme file demonstrating the steps to run the sample. @@ -100,7 +100,7 @@ sure your plans and ours are in sync :) Just open an issue on github and tag it } } ``` -3. Post completion of all of the above steps, create a PR against `master`. +3. Post completion of all of the above steps, create a PR against `main`. #### Commit Guidelines We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. @@ -130,7 +130,7 @@ If the commit reverts a previous commit, it should begin with `revert:`, followe **Rebase and Squash** -* Its manadatory to squash all your commits per scope (i.e package). It is also important to rebase your commits on master. +* Its manadatory to squash all your commits per scope (i.e package). It is also important to rebase your commits on `main`. * Optionally you can split your commits on the basis of the package you are providing code to. **Type** diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 767cfeaab6..f597f4b4aa 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -24,5 +24,5 @@ Please use your Azure subscription if you need to share any information from you ## Console log of the issue: - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fda342332a..cbc7cce44d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -25,7 +25,7 @@ Please follow the instructions and template below to save us time requesting add 4. Include enough information for us to address the bug: - A detailed description. - A [Minimal Complete Reproducible Example](https://stackoverflow.com/help/mcve). This is code we can cut and paste into a readily available sample and run, or a link to a project you've written that we can compile to reproduce the bug. - - Console logs (https://github.com/Azure/azure-iot-sdk-csharp/tree/master/tools/CaptureLogs). + - Console logs (https://github.com/Azure/azure-iot-sdk-csharp/tree/main/tools/CaptureLogs). 5. Delete these instructions before submitting the bug. @@ -51,5 +51,5 @@ Please be as detailed as possible: which feature has a problem, how often does i Please remove any connection string information! ## Console log of the issue -Follow the instructions [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/master/tools/CaptureLogs) to capture SDK logs. +Follow the instructions [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/main/tools/CaptureLogs) to capture SDK logs. Don't forget to remove any connection string information! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 857a0a6add..2dfffb1f67 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,10 +9,10 @@ Need support? --> ## Checklist -- [ ] I have read the [contribution guidelines](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/.github/CONTRIBUTING.md). +- [ ] I have read the [contribution guidelines](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/.github/CONTRIBUTING.md). - [ ] I added or modified the existing tests to cover the change (we do not allow our test coverage to go down). -- [ ] This pull-request is submitted against the `master` branch. - +- [ ] This pull-request is submitted against the `main` branch. + ## Description of the changes diff --git a/device_connection_and_reliability_readme.md b/device_connection_and_reliability_readme.md index dcdd357930..ff4694bc6a 100644 --- a/device_connection_and_reliability_readme.md +++ b/device_connection_and_reliability_readme.md @@ -19,10 +19,10 @@ Authentication can be done using one of the following: - [TPM based authentication](https://azure.microsoft.com/blog/device-provisioning-identity-attestation-with-tpm/) Samples: -- IoT hub device shared access key based authentication sample - [DeviceReconnectionSample](https://github.com/Azure-Samples/azure-iot-samples-csharp/blob/master/iot-hub/Samples/device/DeviceReconnectionSample/DeviceReconnectionSample.cs#L102) -- Device provisioning service symmetric key based authentication sample - [ProvisioningDeviceClientSample](https://github.com/Azure-Samples/azure-iot-samples-csharp/blob/master/provisioning/Samples/device/SymmetricKeySample/ProvisioningDeviceClientSample.cs#L62) -- x509 based authentication sample using CA-signed certificates - [X509DeviceCertWithChainSample](https://github.com/Azure-Samples/azure-iot-samples-csharp/blob/master/iot-hub/Samples/device/X509DeviceCertWithChainSample/Program.cs#L43) -- TPM based authentication sample - [ProvisioningDeviceClientSample](https://github.com/Azure-Samples/azure-iot-samples-csharp/blob/master/provisioning/Samples/device/TpmSample/ProvisioningDeviceClientSample.cs#L49) +- IoT hub device shared access key based authentication sample - [DeviceReconnectionSample](https://github.com/Azure-Samples/azure-iot-samples-csharp/blob/main/iot-hub/Samples/device/DeviceReconnectionSample/DeviceReconnectionSample.cs#L102) +- Device provisioning service symmetric key based authentication sample - [ProvisioningDeviceClientSample](https://github.com/Azure-Samples/azure-iot-samples-csharp/blob/main/provisioning/Samples/device/SymmetricKeySample/ProvisioningDeviceClientSample.cs#L62) +- x509 based authentication sample using CA-signed certificates - [X509DeviceCertWithChainSample](https://github.com/Azure-Samples/azure-iot-samples-csharp/blob/main/iot-hub/Samples/device/X509DeviceCertWithChainSample/Program.cs#L43) +- TPM based authentication sample - [ProvisioningDeviceClientSample](https://github.com/Azure-Samples/azure-iot-samples-csharp/blob/main/provisioning/Samples/device/TpmSample/ProvisioningDeviceClientSample.cs#L49) When using SAS tokens, authentication can be done by: @@ -64,7 +64,7 @@ For both AMQP and MQTT, the SDK will try to reconnect anytime there is any netwo > Note: The default retry policy has support for jitter, which ensures that if you have N devices that disconnected at the same time, all of them won't start reconnecting with the same delay. -For more details on the default retry policy and how to override it, see [retry policy documentation](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/iothub/device/devdoc/retrypolicy.md). +For more details on the default retry policy and how to override it, see [retry policy documentation](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/iothub/device/devdoc/retrypolicy.md). HTTP is a stateless protocol and will work whenever there is network connectivity. diff --git a/e2e/test/prerequisites/readme.md b/e2e/test/prerequisites/readme.md index edfa8ad4fe..680d898a5e 100644 --- a/e2e/test/prerequisites/readme.md +++ b/e2e/test/prerequisites/readme.md @@ -1,11 +1,11 @@ # Azure IoT C# End-to-end test prerequisites -The E2E tests require some Azure resources to be set up and configured. Running the [e2eTestsSetup.ps1](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/e2e/test/prerequisites/E2ETestsSetup/e2eTestsSetup.ps1) powershell script is a convenient way of getting all the resources setup with the required configuration. +The E2E tests require some Azure resources to be set up and configured. Running the [e2eTestsSetup.ps1](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/e2e/test/prerequisites/E2ETestsSetup/e2eTestsSetup.ps1) powershell script is a convenient way of getting all the resources setup with the required configuration. -Note: The [e2eTestsSetup.ps1](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/e2e/test/prerequisites/E2ETestsSetup/e2eTestsSetup.ps1) script will setup all the resources necessary to run the full test suite. Ensure to delete these resources when not required as they will cost money. If you want to specifically create some resources, you can take a look at the script for help. +Note: The [e2eTestsSetup.ps1](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/e2e/test/prerequisites/E2ETestsSetup/e2eTestsSetup.ps1) script will setup all the resources necessary to run the full test suite. Ensure to delete these resources when not required as they will cost money. If you want to specifically create some resources, you can take a look at the script for help. -- Navigate to [e2eTestsSetup.ps1](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/e2e/test/prerequisites/E2ETestsSetup/e2eTestsSetup.ps1) +- Navigate to [e2eTestsSetup.ps1](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/e2e/test/prerequisites/E2ETestsSetup/e2eTestsSetup.ps1) - Open powershell in Administrator mode and run the following command by replacing the variables in brackets with your own preferred values. diff --git a/iothub/device/devdoc/architecture.md b/iothub/device/devdoc/architecture.md index 4c903187e9..07d988d7e0 100644 --- a/iothub/device/devdoc/architecture.md +++ b/iothub/device/devdoc/architecture.md @@ -138,7 +138,7 @@ Immediate cancellation is achieved by using `Dispose()` which closes and dispose | `(ConnectionStatus.Disabled, ConnectionStatusChangeReason.Client_Close)` | Application disposed the client. | | `(ConnectionStatus.Disconnected, ConnectionStatusChangeReason.Communication_Error)` | If no callback subscriptions exist, the client will not automatically connect. A future operation will attempt to reconnect the client. | | `(ConnectionStatus.Disconnected_Retrying, ConnectionStatusChangeReason.Communication_Error)` | If any callback subscriptions exist (methods, twin, events) and connectivity is lost, the client will try to reconnect. | -| `(ConnectionStatus.Disconnected, ConnectionStatusChangeReason.Retry_Expired)` | Retry timeout. The `RetryDelegatingHandler` will attempt to recover links for a duration of `OperationTimeoutInMilliseconds` (default 4 minutes) according to [this retry policy](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/iothub/device/devdoc/requirements/retrypolicy.md). | +| `(ConnectionStatus.Disconnected, ConnectionStatusChangeReason.Retry_Expired)` | Retry timeout. The `RetryDelegatingHandler` will attempt to recover links for a duration of `OperationTimeoutInMilliseconds` (default 4 minutes) according to [this retry policy](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/iothub/device/devdoc/requirements/retrypolicy.md). | | `(ConnectionStatus.Disconnected, ConnectionStatusChangeReason.Bad_Credential)` | UnauthorizedException during Retry. | | `(ConnectionStatus.Disconnected, ConnectionStatusChangeReason.Device_Disabled)` | DeviceDisabledException during Retry. | diff --git a/iothub/device/samples/readme.md b/iothub/device/samples/readme.md index 3908583189..d2e8c60316 100644 --- a/iothub/device/samples/readme.md +++ b/iothub/device/samples/readme.md @@ -65,18 +65,18 @@ You need to clone the repository or download the sample (the one you want to try dotnet run ``` -[device-samples]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device -[d-message-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/DeviceReconnectionSample -[d-receive-message-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/MessageReceiveSample -[d-method-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/MethodSample -[d-twin-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/TwinSample -[d-file-upload-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/FileUploadSample -[d-x509-cert-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/X509DeviceCertWithChainSample -[d-import-export-devices-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/ImportExportDevicesSample -[d-pnp-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/PnpDeviceSamples -[d-xamarin-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/XamarinSample - -[m-message-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/module/ModuleSample +[device-samples]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device +[d-message-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/DeviceReconnectionSample +[d-receive-message-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/MessageReceiveSample +[d-method-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/MethodSample +[d-twin-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/TwinSample +[d-file-upload-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/FileUploadSample +[d-x509-cert-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/X509DeviceCertWithChainSample +[d-import-export-devices-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/ImportExportDevicesSample +[d-pnp-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/PnpDeviceSamples +[d-xamarin-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/XamarinSample + +[m-message-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/module/ModuleSample [lnk-setup-iot-hub]: https://aka.ms/howtocreateazureiothub [lnk-manage-iot-device]: https://github.com/Azure/azure-iot-device-ecosystem/blob/master/setup_iothub.md#create-new-device-in-the-iot-hub-device-identity-registry \ No newline at end of file diff --git a/iothub/device/src/Common/Exceptions/IotHubCommunicationException.cs b/iothub/device/src/Common/Exceptions/IotHubCommunicationException.cs index 165433891e..5332b29ce2 100644 --- a/iothub/device/src/Common/Exceptions/IotHubCommunicationException.cs +++ b/iothub/device/src/Common/Exceptions/IotHubCommunicationException.cs @@ -13,7 +13,7 @@ namespace Microsoft.Azure.Devices.Client.Exceptions /// /// /// By default, the SDK indefinitely retries dropped connections, unless the retry policy is overridden. - /// For more information on the SDK's retry policy and how to override it, see . + /// For more information on the SDK's retry policy and how to override it, see . /// When the exception is thrown due to operation timeouts, the inner exception will have OperationCanceledException. /// Retrying operations failed due to timeouts could resolve the error. /// diff --git a/iothub/service/samples/readme.md b/iothub/service/samples/readme.md index 4460522296..196360f4a1 100644 --- a/iothub/service/samples/readme.md +++ b/iothub/service/samples/readme.md @@ -15,13 +15,13 @@ Service samples were moved to [Azure-Samples/azure-iot-samples-csharp][samples-r [samples-repo]: https://github.com/Azure-Samples/azure-iot-samples-csharp -[service-samples]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service -[adm-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/AutomaticDeviceManagementSample +[service-samples]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service +[adm-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/AutomaticDeviceManagementSample [device-streaming-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/preview/iot-hub/Samples/service/DeviceStreamingSample -[edge-deployment-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/EdgeDeploymentSample -[import-export-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/ImportExportDevicesSample -[jobs-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/JobsSample -[reg-man-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/RegistryManagerSample -[service-client-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/ServiceClientSample -[pnp-service-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/PnpServiceSamples -[digital-twin-client-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/DigitalTwinClientSamples +[edge-deployment-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/EdgeDeploymentSample +[import-export-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/ImportExportDevicesSample +[jobs-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/JobsSample +[reg-man-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/RegistryManagerSample +[service-client-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/ServiceClientSample +[pnp-service-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/PnpServiceSamples +[digital-twin-client-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/DigitalTwinClientSamples diff --git a/iothub/service/src/DigitalTwin/readme.md b/iothub/service/src/DigitalTwin/readme.md index 1c0f96fb6a..a937bc9f05 100644 --- a/iothub/service/src/DigitalTwin/readme.md +++ b/iothub/service/src/DigitalTwin/readme.md @@ -6,7 +6,7 @@ ### Examples -You can familiarize yourself with different APIs using [samples for DigitalTwinClient](https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/service/DigitalTwinClientSamples). +You can familiarize yourself with different APIs using [samples for DigitalTwinClient](https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/DigitalTwinClientSamples). ## Source code folder structure diff --git a/provisioning/device/samples/readme.md b/provisioning/device/samples/readme.md index c59f6f4629..e80c59f380 100644 --- a/provisioning/device/samples/readme.md +++ b/provisioning/device/samples/readme.md @@ -6,6 +6,6 @@ Device provisioning samples were moved to [Azure-Samples/azure-iot-samples-cshar [samples-repo]: https://github.com/Azure-Samples/azure-iot-samples-csharp -[service-device-samples]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/provisioning/Samples/device -[x509-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/provisioning/Samples/device/X509Sample -[tpm-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/provisioning/Samples/device/TpmSample \ No newline at end of file +[service-device-samples]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/provisioning/Samples/device +[x509-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/provisioning/Samples/device/X509Sample +[tpm-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/provisioning/Samples/device/TpmSample \ No newline at end of file diff --git a/provisioning/device/src/CertificateInstaller.cs b/provisioning/device/src/CertificateInstaller.cs index 077ed41770..3bcf93a907 100644 --- a/provisioning/device/src/CertificateInstaller.cs +++ b/provisioning/device/src/CertificateInstaller.cs @@ -17,7 +17,7 @@ internal static class CertificateInstaller /// /// Because Intermediate Authorities may have been issued by the uploaded CA, the application must present the full chain of /// certificates from the one used during authentication to the one uploaded to the service. - /// See + /// See /// for more information. /// /// The certificate chain to ensure is installed. diff --git a/provisioning/service/samples/readme.md b/provisioning/service/samples/readme.md index 66d67982d9..6dce11524d 100644 --- a/provisioning/service/samples/readme.md +++ b/provisioning/service/samples/readme.md @@ -7,8 +7,8 @@ Service provisioning samples were moved to [Azure-Samples/azure-iot-samples-csha * [EnrollmentGroupSample][enrollment-group-sample] [samples-repo]: https://github.com/Azure-Samples/azure-iot-samples-csharp -[service-prov-samples]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/provisioning/Samples/service -[group-cert-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/provisioning/Samples/service/GroupCertificateVerificationSample -[bulk-op-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/provisioning/Samples/service/BulkOperationSample -[enrollment-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/provisioning/Samples/service/EnrollmentSample -[enrollment-group-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/provisioning/Samples/service/EnrollmentGroupSample \ No newline at end of file +[service-prov-samples]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/provisioning/Samples/service +[group-cert-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/provisioning/Samples/service/GroupCertificateVerificationSample +[bulk-op-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/provisioning/Samples/service/BulkOperationSample +[enrollment-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/provisioning/Samples/service/EnrollmentSample +[enrollment-group-sample]: https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/provisioning/Samples/service/EnrollmentGroupSample \ No newline at end of file diff --git a/readme.md b/readme.md index aa4ef97d86..820897f0f0 100644 --- a/readme.md +++ b/readme.md @@ -31,7 +31,7 @@ Due to security considerations, build logs are not publicly available. | Service Environment | Status | | --- | --- | -| [Master](https://github.com/Azure/azure-iot-sdk-csharp/tree/master) | [![Build Status](https://azure-iot-sdks.visualstudio.com/azure-iot-sdks/_apis/build/status/csharp/CSharp%20Prod%20-%20West%20Central%20US?branchName=master)](https://azure-iot-sdks.visualstudio.com/azure-iot-sdks/_build/latest?definitionId=44&repositoryFilter=9&branchName=master) | +| [Main](https://github.com/Azure/azure-iot-sdk-csharp/tree/main) | [![Build Status](https://azure-iot-sdks.visualstudio.com/azure-iot-sdks/_apis/build/status/csharp/CSharp%20Prod%20-%20West%20Central%20US?branchName=main)](https://azure-iot-sdks.visualstudio.com/azure-iot-sdks/_build/latest?definitionId=44&repositoryFilter=9&branchName=main) | | [Preview](https://github.com/Azure/azure-iot-sdk-csharp/tree/preview) | [![Build Status](https://azure-iot-sdks.visualstudio.com/azure-iot-sdks/_apis/build/status/csharp/CSharp%20Canary%20-%20Central%20US%20EUAP?branchName=preview)](https://azure-iot-sdks.visualstudio.com/azure-iot-sdks/_build/latest?definitionId=402&repositoryFilter=9&branchName=preview) | ### Recommended NuGet packages @@ -81,7 +81,7 @@ Visit [Azure IoT Dev Center][iot-dev-center] to learn more about developing appl Most of our samples are available at [Azure IoT Samples for C#](https://github.com/Azure-Samples/azure-iot-samples-csharp). -If you are looking for a good device sample to get started with, please see the [device reconnection sample](https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/master/iot-hub/Samples/device/DeviceReconnectionSample). +If you are looking for a good device sample to get started with, please see the [device reconnection sample](https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/device/DeviceReconnectionSample). It shows how to connect a device, handle disconnect events, cases to handle when making calls, and when to re-initialize the `DeviceClient`. ## Contribute to the Azure IoT C# SDK @@ -165,7 +165,7 @@ This repository contains [provisioning service client SDK](./provisioning/servic - [Set up your development environment](./doc/devbox_setup.md) to prepare your development environment as well as how to run the samples on Linux, Windows or other platforms. - [API reference documentation for .NET](https://docs.microsoft.com/dotnet/api/overview/azure/devices?view=azure-dotnet) - [Get Started with IoT Hub using .NET](https://docs.microsoft.com/azure/iot-hub/iot-hub-csharp-csharp-getstarted) -- [Device connection and messaging reliability](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/device_connection_and_reliability_readme.md) +- [Device connection and messaging reliability](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/device_connection_and_reliability_readme.md) > Device Explorer is no longer supported. A replacement tool can be found [here](https://github.com/Azure/azure-iot-explorer). diff --git a/tools/CaptureLogs/readme.md b/tools/CaptureLogs/readme.md index 6d0efa77ae..2918d1f1dd 100644 --- a/tools/CaptureLogs/readme.md +++ b/tools/CaptureLogs/readme.md @@ -11,7 +11,7 @@ We have provided the following convenience scripts for log collection using `log 1. `-TraceName` - the name of the event trace data collector. This can be any name that will be used to identity the collector created. 2. `-Output` - the output log file that will be created. This should be a `.etl` file. 3. `-ProviderFile` - The file listing multiple Event Trace providers to enable. The file should be a text file containing one provider per line. - The Azure IoT SDK providers file is present [here](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/tools/CaptureLogs/iot_providers.txt). The providers list with their corresponding package details are present [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/master/tools/CaptureLogs#azure-iot-sdk-providers). + The Azure IoT SDK providers file is present [here](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/tools/CaptureLogs/iot_providers.txt). The providers list with their corresponding package details are present [here](https://github.com/Azure/azure-iot-sdk-csharp/tree/main/tools/CaptureLogs#azure-iot-sdk-providers). Sample usage: @@ -35,7 +35,7 @@ On Linux and OSX LTTNG and perfcollect can be used to collect traces. For more i ## Console logging Logging can be added to console. Note that this method will substantially slow down execution. - 1. Add [`e2e\test\helpers\ConsoleEventListener.cs`](https://github.com/Azure/azure-iot-sdk-csharp/blob/master/e2e/test/helpers/ConsoleEventListener.cs) to your project. + 1. Add [`e2e\test\helpers\ConsoleEventListener.cs`](https://github.com/Azure/azure-iot-sdk-csharp/blob/main/e2e/test/helpers/ConsoleEventListener.cs) to your project. 2. Instantiate the listener. Add one or more filters (e.g. `Microsoft-Azure-` or `DotNetty-`): ```csharp diff --git a/tools/diffscripts/README.md b/tools/diffscripts/README.md index e222c78f17..d79ef25b18 100644 --- a/tools/diffscripts/README.md +++ b/tools/diffscripts/README.md @@ -108,7 +108,7 @@ VERBOSE: Repository base path: C:\repos VERBOSE: AsmDiff executable: dotnet-asmdiff.exe VERBOSE: Using user supplied iot-sdk-internals repository. VERBOSE: Using C:\adtexplorer\ for the internals sdk repository base directory. -VERBOSE: Directory where the SDK markdown files will be generated: C:\adtexplorer\sdk_design_docs\CSharp\master +VERBOSE: Directory where the SDK markdown files will be generated: C:\adtexplorer\sdk_design_docs\CSharp\main ... ... ``` @@ -193,15 +193,15 @@ Creating markdown for C:\repos\azure-iot-sdk-csharp\provisioning\transport\http\ Creating markdown for C:\repos\azure-iot-sdk-csharp\security\tpm\src\bin\Release\netstandard2.1\Microsoft.Azure.Devices.Provisioning.Security.Tpm.dll Changes have been detected. Verify each file listed below to be sure of the scope of changes. -There have been 3 deletions and 9 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Client.md -There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Client.md -There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Security.Tpm.md -There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Service.md -There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Transport.Amqp.md -There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Transport.Http.md -There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Transport.Mqtt.md -There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Shared.md -There have been 9 deletions and 7 additions to sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.md +There have been 3 deletions and 9 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Client.md +There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Client.md +There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Security.Tpm.md +There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Service.md +There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Transport.Amqp.md +There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Transport.Http.md +There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Transport.Mqtt.md +There have been 0 deletions and 2 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Shared.md +There have been 9 deletions and 7 additions to sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.md Finished generating the markdown files for comparison. Review the output above for release notes and to determine if there are version changes. ``` \ No newline at end of file diff --git a/tools/diffscripts/diffapi.ps1 b/tools/diffscripts/diffapi.ps1 index d6ca222165..4fc14c4d0c 100644 --- a/tools/diffscripts/diffapi.ps1 +++ b/tools/diffscripts/diffapi.ps1 @@ -64,7 +64,7 @@ Param( })] # The path of the iot-sdk-internals repository (ex: c:\repo\iot-sdks-internals) [System.IO.FileInfo] $SDKInternalsPath = $null, - # Indicates you will compare the output to the last preview version instead of master + # Indicates you will compare the output to the last preview version instead of main [switch] $IsPreview ) @@ -137,7 +137,7 @@ else Write-Verbose "Using $internalRootPath for the internals sdk repository base directory." # If we specify to use the preview directory on the command line we will set it as such -$compareDirectory = Join-Path -Path $internalRootPath -Child "\sdk_design_docs\CSharp\master" +$compareDirectory = Join-Path -Path $internalRootPath -Child "\sdk_design_docs\CSharp\main" if ($IsPreview) { $compareDirectory = Join-Path -Path $internalRootPath -Child "\sdk_design_docs\CSharp\preview" @@ -302,15 +302,15 @@ Set-Location -Path $compareDirectory # # # https://git-scm.com/docs/git-diff # -# 9 3 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Client.md -# 2 0 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Client.md -# 2 0 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Security.Tpm.md -# 2 0 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Service.md -# 2 0 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Transport.Amqp.md -# 2 0 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Transport.Http.md -# 2 0 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Provisioning.Transport.Mqtt.md -# 2 0 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.Shared.md -# 7 9 sdk_design_docs/CSharp/master/Microsoft.Azure.Devices.md +# 9 3 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Client.md +# 2 0 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Client.md +# 2 0 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Security.Tpm.md +# 2 0 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Service.md +# 2 0 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Transport.Amqp.md +# 2 0 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Transport.Http.md +# 2 0 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Provisioning.Transport.Mqtt.md +# 2 0 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.Shared.md +# 7 9 sdk_design_docs/CSharp/main/Microsoft.Azure.Devices.md $gitDiffOutput = git diff --ignore-all-space --numstat Write-Verbose "Output off git diff --ignore-all-space --numstat" diff --git a/vsts/vsts.yaml b/vsts/vsts.yaml index 6d2c65c4c8..a7f8c7de81 100644 --- a/vsts/vsts.yaml +++ b/vsts/vsts.yaml @@ -4,7 +4,7 @@ trigger: batch: true branches: include: - - master + - main paths: exclude: - docs/*