[Storage] endpoint parameter to `account_url#4388
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates Azure Storage Queue and Blob client constructors and related code samples/tests to use the term account_url instead of endpoint, aligning naming with the broader Storage client surface.
Changes:
- Renames constructor parameter identifiers from
endpointtoaccount_urlacross Queue and Blob clientnew()constructors (plus corresponding doc/error-message wording updates). - Updates Queue/Blob tests, examples, READMEs, and sample apps to use
account_urlnaming consistently. - Adds release notes entries describing the rename.
Reviewed changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/storage/azure_storage_queue/tests/queue_service_client.rs | Updates test helper client construction to use account_url variable naming. |
| sdk/storage/azure_storage_queue/tests/queue_client.rs | Updates queue client tests to use account_url naming when constructing clients. |
| sdk/storage/azure_storage_queue/tests/common/mod.rs | Renames test setup return values/documentation from “endpoint” to “account URL”. |
| sdk/storage/azure_storage_queue/src/clients/queue_service_client.rs | Renames QueueServiceClient::new() parameter identifier/docs/messages to account_url. |
| sdk/storage/azure_storage_queue/src/clients/queue_client.rs | Renames QueueClient::new() parameter identifier and updates an error message to “account URL”. |
| sdk/storage/azure_storage_queue/README.md | Updates README snippet comment from “Endpoint” to “Account URL”. |
| sdk/storage/azure_storage_queue/examples/queue_storage_logging.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_queue/examples/queue_service_client.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_queue/examples/queue_hello_world.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_queue/examples/queue_client.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_queue/examples/access_policy.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_queue/CHANGELOG.md | Adds an entry describing the endpoint -> account_url parameter rename. |
| sdk/storage/azure_storage_blob/tests/blob_service_client.rs | Renames test variable endpoint -> account_url for secondary URL construction and client creation. |
| sdk/storage/azure_storage_blob/tests/blob_client.rs | Renames test “Endpoint” variable/comment to “Account URL” and updates uses. |
| sdk/storage/azure_storage_blob/src/clients/page_blob_client.rs | Renames new() parameter identifier/docs/messages to account_url. |
| sdk/storage/azure_storage_blob/src/clients/block_blob_client.rs | Renames new() parameter identifier/docs/messages to account_url. |
| sdk/storage/azure_storage_blob/src/clients/blob_service_client.rs | Renames BlobServiceClient::new() parameter identifier/docs/messages to account_url. |
| sdk/storage/azure_storage_blob/src/clients/blob_container_client.rs | Renames new() parameter identifier/docs/messages to account_url. |
| sdk/storage/azure_storage_blob/src/clients/blob_client.rs | Renames new() parameter identifier/docs/messages to account_url. |
| sdk/storage/azure_storage_blob/src/clients/append_blob_client.rs | Renames new() parameter identifier/docs/messages to account_url. |
| sdk/storage/azure_storage_blob/README.md | Updates README snippet comment from “Endpoint” to “Account URL”. |
| sdk/storage/azure_storage_blob/perf/upload_blob_test.rs | Renames perf test local variable and logging from “endpoint” to “account URL”. |
| sdk/storage/azure_storage_blob/perf/list_blob_test.rs | Renames perf test local variable and logging from “endpoint” to “account URL”. |
| sdk/storage/azure_storage_blob/perf/download_blob_test.rs | Renames perf test local variable and logging from “endpoint” to “account URL”. |
| sdk/storage/azure_storage_blob/examples/storage_error.rs | Renames example variable endpoint -> account_url and updates constructor call formatting. |
| sdk/storage/azure_storage_blob/examples/page_blob_client.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/examples/block_blob_client.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/examples/blob_storage_upload_file.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/examples/blob_storage_logging.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/examples/blob_service_client.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/examples/blob_hello_world.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/examples/blob_container_client.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/examples/blob_client.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/examples/append_blob_client.rs | Renames example variable endpoint -> account_url and updates constructor call. |
| sdk/storage/azure_storage_blob/CHANGELOG.md | Adds an entry describing the endpoint -> account_url parameter rename for Blob clients. |
| sdk/storage/azure_storage_blob_test/src/lib.rs | Renames test helper variable/docs from “endpoint” to “account URL”. |
| samples/list_blobs_rustls_symcrypt/src/main.rs | Renames sample variable endpoint -> account_url and updates constructor call. |
| samples/list_blobs_native_tls/src/main.rs | Renames sample variable endpoint -> account_url and updates constructor call. |
| ### Breaking Changes | ||
|
|
||
| - Renamed the `endpoint` parameter on `QueueClient::new()` and `QueueServiceClient::new()` to `account_url`. | ||
| - Renamed `QueueClient::endpoint()` and `QueueServiceClient::endpoint()` to `url()` for consistency with other Storage clients. |
|
|
||
| ### Breaking Changes | ||
|
|
||
| - Renamed the `endpoint` parameter on `new()` to `account_url` for `BlobClient`, `BlockBlobClient`, `AppendBlobClient`, `PageBlobClient`, `BlobContainerClient`, and `BlobServiceClient`. |
| // The reqwest/native-tls feature automatically configures native-tls as the TLS provider. | ||
| let container_client = | ||
| BlobContainerClient::new(&endpoint, &args.container_name, Some(credential), None)?; | ||
| BlobContainerClient::new(&account_url, &args.container_name, Some(credential), None)?; |
There was a problem hiding this comment.
Did you folks change your parameter name as well? The guidelines are "endpoint" for the server host name. This mirrors Java, Python, and Go i.e. most of our languages. I'm not okay with that. You may be taking "endpoint" too literally here if you expect it only to mean the REST API endpoint.
|
Aww man, Analyze is failing for some reason. Despite having
|
|
If you click on the build, it shows,
|
Yeah I see that, it was curious to me though because (as linked above) we have and that line ( Anyways we discussed more internally and we are happy with it as-is. |
No description provided.