az storage account blob-access-point-configuration

Manage Blob Access Point Configuration.

Commands

Name Description Type Status
az storage account blob-access-point-configuration create

Create a Blob Access Point configuration.

Core GA
az storage account blob-access-point-configuration delete

Delete a Blob Access Point configuration.

Core GA
az storage account blob-access-point-configuration list

List all Blob Access Point configurations in a Storage Account.

Core GA
az storage account blob-access-point-configuration show

Get the specified Blob Access Point configuration.

Core GA
az storage account blob-access-point-configuration test-existing-connection

Test the connection configured on an existing Blob Access Point configuration.

Core GA
az storage account blob-access-point-configuration test-proposed-connection

Test a proposed Blob Access Point connection before the configuration is created. The connection is validated in the context of the storage account in the request path, so no Blob Access Point configuration needs to exist beforehand.

Core GA
az storage account blob-access-point-configuration update

Update a Blob Access Point configuration.

Core GA
az storage account blob-access-point-configuration wait

Place the CLI in a waiting state until a condition is met.

Core GA

az storage account blob-access-point-configuration create

Create a Blob Access Point configuration.

az storage account blob-access-point-configuration create --account-name
                                                          --blob-access-point-configuration-name --name
                                                          --resource-group
                                                          --source
                                                          [--acquire-policy-token]
                                                          [--change-reference]
                                                          [--description]
                                                          [--location]
                                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                          [--state {Active, Inactive}]
                                                          [--tags]

Examples

Create for a Blob Access Point configuration

az storage account blob-access-point-configuration create --resource-group MyResourceGroup --account-name mystorageaccount --name myaccesspoint --location eastus --source '{"s3-compatible":{"connection":{"endpoint":{"endpoint":"https://s3.example.com"}},"auth":{"access-key":{"access-key-id":"<access-key-id>","secret-access-key":"<secret-access-key>"}}}}'

Required Parameters

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

--blob-access-point-configuration-name --name -n

The name of the Blob Access Point configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--source

Information about the backing data source. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--description

An arbitrary description of the Blob Access Point configuration.

Property Value
Parameter group: Properties Arguments
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Resource Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--state

The configuration state. A configuration is created in the Active state when this value is not specified.

Property Value
Parameter group: Properties Arguments
Accepted values: Active, Inactive
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage account blob-access-point-configuration delete

Delete a Blob Access Point configuration.

az storage account blob-access-point-configuration delete [--account-name]
                                                          [--acquire-policy-token]
                                                          [--blob-access-point-configuration-name --name]
                                                          [--change-reference]
                                                          [--ids]
                                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                          [--resource-group]
                                                          [--subscription]
                                                          [--yes]

Examples

Delete for a Blob Access Point configuration

az storage account blob-access-point-configuration delete --resource-group MyResourceGroup --account-name mystorageaccount --name myaccesspoint

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--blob-access-point-configuration-name --name -n

The name of the Blob Access Point configuration.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage account blob-access-point-configuration list

List all Blob Access Point configurations in a Storage Account.

az storage account blob-access-point-configuration list --account-name
                                                        --resource-group
                                                        [--max-items]
                                                        [--next-token]

Examples

List for a Blob Access Point configuration

az storage account blob-access-point-configuration list --resource-group MyResourceGroup --account-name mystorageaccount

Required Parameters

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage account blob-access-point-configuration show

Get the specified Blob Access Point configuration.

az storage account blob-access-point-configuration show [--account-name]
                                                        [--blob-access-point-configuration-name --name]
                                                        [--ids]
                                                        [--resource-group]
                                                        [--subscription]

Examples

Show for a Blob Access Point configuration

az storage account blob-access-point-configuration show --resource-group MyResourceGroup --account-name mystorageaccount --name myaccesspoint

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--blob-access-point-configuration-name --name -n

The name of the Blob Access Point configuration.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage account blob-access-point-configuration test-existing-connection

Test the connection configured on an existing Blob Access Point configuration.

az storage account blob-access-point-configuration test-existing-connection --unique-id
                                                                            [--account-name]
                                                                            [--acquire-policy-token]
                                                                            [--blob-access-point-configuration-name --name]
                                                                            [--change-reference]
                                                                            [--ids]
                                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                            [--resource-group]
                                                                            [--subscription]

Examples

Test existing connection for a Blob Access Point configuration

az storage account blob-access-point-configuration test-existing-connection --resource-group MyResourceGroup --account-name mystorageaccount --name myaccesspoint --unique-id 00000000-0000-0000-0000-000000000001

Required Parameters

--unique-id

The system-generated unique identifier of the Blob Access Point configuration, as returned by a read operation. This value must match the configuration named in the request path, and is required so that a configuration which was deleted and recreated under the same name is not tested by mistake.

Property Value
Parameter group: Body Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--blob-access-point-configuration-name --name -n

The name of the Blob Access Point configuration.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage account blob-access-point-configuration test-proposed-connection

Test a proposed Blob Access Point connection before the configuration is created. The connection is validated in the context of the storage account in the request path, so no Blob Access Point configuration needs to exist beforehand.

az storage account blob-access-point-configuration test-proposed-connection --source
                                                                            [--account-name]
                                                                            [--acquire-policy-token]
                                                                            [--change-reference]
                                                                            [--ids]
                                                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                            [--resource-group]
                                                                            [--subscription]

Examples

Test proposed connection for a Blob Access Point configuration

az storage account blob-access-point-configuration test-proposed-connection --resource-group MyResourceGroup --account-name mystorageaccount --source '{"s3-compatible":{"connection":{"endpoint":{"endpoint":"https://s3.example.com"}},"auth":{"access-key":{"access-key-id":"<access-key-id>","secret-access-key":"<secret-access-key>"}}}}'

Required Parameters

--source

Information about the backing data source whose connection is tested. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage account blob-access-point-configuration update

Update a Blob Access Point configuration.

az storage account blob-access-point-configuration update [--account-name]
                                                          [--acquire-policy-token]
                                                          [--blob-access-point-configuration-name --name]
                                                          [--change-reference]
                                                          [--description]
                                                          [--ids]
                                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                          [--resource-group]
                                                          [--source]
                                                          [--state {Active, Inactive}]
                                                          [--subscription]
                                                          [--tags]

Examples

Update for a Blob Access Point configuration

az storage account blob-access-point-configuration update --resource-group MyResourceGroup --account-name mystorageaccount --name myaccesspoint --description 'Updated access point description'

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--blob-access-point-configuration-name --name -n

The name of the Blob Access Point configuration.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--description

An arbitrary description of the Blob Access Point configuration.

Property Value
Parameter group: Properties Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--source

Information about the backing data source. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--state

The configuration state. A configuration is created in the Active state when this value is not specified.

Property Value
Parameter group: Properties Arguments
Accepted values: Active, Inactive
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage account blob-access-point-configuration wait

Place the CLI in a waiting state until a condition is met.

az storage account blob-access-point-configuration wait [--account-name]
                                                        [--acquire-policy-token]
                                                        [--blob-access-point-configuration-name --name]
                                                        [--change-reference]
                                                        [--created]
                                                        [--custom]
                                                        [--deleted]
                                                        [--exists]
                                                        [--ids]
                                                        [--interval]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--timeout]
                                                        [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--blob-access-point-configuration-name --name -n

The name of the Blob Access Point configuration.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Request timeout in seconds. Applies to each call to the service.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False