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.

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

Replaced relative link with absolute links and remove locale #433

Merged
merged 6 commits into from
Sep 18, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ For your convenience, each service has a separate set of libraries that you can

### Libraries available

Currently, the client libraries are in **preview**. These libraries follow the [Azure SDK Design Guidelines for iOS](https://azure.github.io/azure-sdk/ios_introduction.html) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features in [AzureCore](sdk/core/AzureCore/README.md).
Currently, the client libraries are in **preview**. These libraries follow the [Azure SDK Design Guidelines for iOS](https://azure.github.io/azure-sdk/ios_introduction.html) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features in [AzureCore](https://github.com/Azure/azure-sdk-for-ios/blob/master/sdk/core/AzureCore/README.md).

The following libraries are currently in **preview**:
- [AzureStorageBlob](sdk/storage/AzureStorageBlob)
- [AzureStorageBlob](https://github.com/Azure/azure-sdk-for-ios/blob/master/sdk/storage/AzureStorageBlob)

> Note: The SDK is currently in **preview**. The API surface and feature sets are subject to change at any time before **GA**. We do not currently recommend them for production use.

Expand Down Expand Up @@ -54,7 +54,7 @@ following the library's
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).

## Contributing
For details on contributing to this repository, see the [contributing guide](CONTRIBUTING.md).
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-ios/blob/master/CONTRIBUTING.md).

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.
Expand Down
1 change: 1 addition & 0 deletions eng/pipelines/templates/jobs/archetype-sdk-client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ jobs:
- template: ../../../common/pipelines/templates/steps/verify-links.yml
parameters:
Directory: ""
CheckLinkGuidance: $true

- script: |
brew install swiftlint
Expand Down
16 changes: 8 additions & 8 deletions examples/AzureFunctionSASTokenVendor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ a per-client path prefix within a Storage Container.
This project provides examples for the following scenarios:

* Using the
[Azure Functions Python Runtime](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-azure-function-azure-cli?pivots=programming-language-python)
[Azure Functions Python Runtime](https://docs.microsoft.com/azure/azure-functions/functions-create-first-azure-function-azure-cli?pivots=programming-language-python)
to host an API endpoint which generates scoped Blob Storage SAS tokens for
client applications.

Expand All @@ -22,22 +22,22 @@ This project provides examples for the following scenarios:

### Prerequisites
* You must have the
[Azure Functions Core Tools version 3.x](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local#v2) installed to run this example.
[Azure Functions Core Tools version 3.x](https://docs.microsoft.com/azure/azure-functions/functions-run-local#v2) installed to run this example.
* This example is written in Python. Because version 3.x of the Azure Functions
Core Runtime supports Python 3.8+ only, you must have
[Python 3.8](https://www.python.org/downloads/) or higher installed to run
this example.
* You must have an [Azure subscription](https://azure.microsoft.com/free/),
an active
[storage account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create),
and a [blob container](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container)
[storage account](https://docs.microsoft.com/azure/storage/common/storage-account-create),
and a [blob container](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container)
within that storage account to run this example.

### Installation

1. If you don't already have it,
[install Python](https://www.python.org/downloads/) and the
[Azure Functions Core Tools](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local#v2).
[Azure Functions Core Tools](https://docs.microsoft.com/azure/azure-functions/functions-run-local#v2).
This example is compatible with Python 3.8 and higher and Azure Functions
Core Tools 3.x.

Expand Down Expand Up @@ -65,9 +65,9 @@ This project provides examples for the following scenarios:
python3 -m pip install -r requirements.txt
```

3. Edit the [`local.settings.json`](local.settings.json) file to include your
3. Edit the [`https://github.com/Azure/azure-sdk-for-ios/blob/master/examples/AzureFunctionSASTokenVendor/local.settings.json`](https://github.com/Azure/azure-sdk-for-ios/blob/master/examples/AzureFunctionSASTokenVendor/local.settings.json) file to include your
storage account name,
[storage account access key](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage#view-account-access-keys),
[storage account access key](https://docs.microsoft.com/azure/storage/common/storage-account-keys-manage#view-account-access-keys),
and blob container name:
```json
{
Expand Down Expand Up @@ -125,7 +125,7 @@ authenticate a PUT request (upload) to that path:
### Authenticating a StorageBlobClient with a StorageSASCredential

Deploy the example function to Azure following the
[Quickstart guide](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-azure-function-azure-cli?pivots=programming-language-python#create-supporting-azure-resources-for-your-function).
[Quickstart guide](https://docs.microsoft.com/azure/azure-functions/functions-create-first-azure-function-azure-cli?pivots=programming-language-python#create-supporting-azure-resources-for-your-function).

The publish command shows results similar to the following output (truncated for simplicity):
```
Expand Down
12 changes: 6 additions & 6 deletions sdk/storage/AzureStorageBlob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,9 @@ You can generate a SAS token from the Azure Portal under "Settings" > "Shared ac
signature" (account-scoped) or by right-clicking a blob within a container and selecting "Generate SAS" (blob-scoped).
You can also generate account-, container-, and blob-scoped SAS tokens using Azure Storage Explorer by right-clicking
the desired resource and selecting "Get Shared Access Signature...", or using the Azure CLI
([account](https://docs.microsoft.com/en-us/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-generate-sas),
[container](https://docs.microsoft.com/en-us/cli/azure/storage/container?view=azure-cli-latest#az-storage-container-generate-sas),
[blob](https://docs.microsoft.com/en-us/cli/azure/storage/blob?view=azure-cli-latest#az-storage-blob-generate-sas)).
([account](https://docs.microsoft.com/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-generate-sas),
[container](https://docs.microsoft.com/cli/azure/storage/container?view=azure-cli-latest#az-storage-container-generate-sas),
[blob](https://docs.microsoft.com/cli/azure/storage/blob?view=azure-cli-latest#az-storage-blob-generate-sas)).

Because SAS tokens can be limited in scope and permissions, `StorageSASCredential` is unique in that it is initialized
with a closure that will be called each time its `StorageBlobClient` needs a new token to authenticate a request. Within
Expand Down Expand Up @@ -211,13 +211,13 @@ let client = try StorageBlobClient(endpoint: endpointUrl, credential: msalCreden
```

##### Storage account shared access key
To use a [shared access key](https://docs.microsoft.com/en-us/rest/api/storageservices/authorize-with-shared-key),
To use a [shared access key](https://docs.microsoft.com/rest/api/storageservices/authorize-with-shared-key),
you'll create a `StorageSharedKeyCredential` using the storage account connection string, or a combination of the
account name and access key. You can find the connection string and access keys for your storage account in the Azure
Portal under "Settings" > "Access keys", in Azure Storage Explorer located in the storage account's "Properties" pane,
or using the Azure CLI
([connection string](https://docs.microsoft.com/en-us/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-show-connection-string),
[access keys](https://docs.microsoft.com/en-us/cli/azure/storage/account/keys?view=azure-cli-latest#az-storage-account-keys-list)).
([connection string](https://docs.microsoft.com/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-show-connection-string),
[access keys](https://docs.microsoft.com/cli/azure/storage/account/keys?view=azure-cli-latest#az-storage-account-keys-list)).

> **WARNING**: Shared keys are inherently insecure in end-user facing applications such as mobile and desktop apps.
> Shared keys provide full access to an entire storage account and should not be shared with end users. Since mobile and
Expand Down