az afd auth-policy

  • Preview

Note

This reference is part of the cdn extension for the Azure CLI (version 2.85.0 or higher). The extension will automatically install the first time you run an az afd auth-policy command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage authentication policies within an Azure Front Door profile.

Commands

Name Description Type Status
az afd auth-policy create

Create an authorization policy within the specified profile.

 Extension Preview
az afd auth-policy delete

Delete an existing authorization policy within a profile.

 Extension Preview
az afd auth-policy list

List authorization policies associated with the profile.

 Extension Preview
az afd auth-policy show

Get an existing authorization policy within a profile.

 Extension Preview
az afd auth-policy update

Update an authorization policy within the specified profile.

 Extension Preview
az afd auth-policy wait

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

 Extension Preview

az afd auth-policy create

Preview

Command group 'az afd auth-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an authorization policy within the specified profile.

az afd auth-policy create --auth-policy-name --name
                          --profile-name
                          --resource-group
                          [--acquire-policy-token]
                          [--action {Block, Log}]
                          [--associations]
                          [--auth-configs]
                          [--change-reference]
                          [--forward-token --forward-token-to-origin {0, 1, f, false, n, no, t, true, y, yes}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

AuthPolicies_Create

az afd auth-policy create --resource-group RG --profile-name profile1 --auth-policy-name authPolicy1 --action Block --forward-token-to-origin True --associations "{domains:[{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1}],is-profile-level:False,routes:[{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1}]}" --auth-configs "[{entra-id:{audiences:[11111111-1111-1111-1111-111111111111],auth-location:Header,auth-location-selector:Authorization,issuer:'https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0'}}]"

Required Parameters

--auth-policy-name --name -n

Name of the authorization policy under the profile.

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--action

Action to apply when authorization fails.

Property Value
Parameter group: Properties Arguments
Default value: Block
Accepted values: Block, Log
--associations

Resource associations for the authorization policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--auth-configs

Authorization configurations for the policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--forward-token --forward-token-to-origin

Whether to forward the authentication token to the origin. Defaults to true.

Property Value
Parameter group: Properties Arguments
Default value: True
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
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 afd auth-policy delete

Preview

Command group 'az afd auth-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an existing authorization policy within a profile.

az afd auth-policy delete [--acquire-policy-token]
                          [--auth-policy-name --name]
                          [--change-reference]
                          [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--profile-name]
                          [--resource-group]
                          [--subscription]
                          [--yes]

Examples

AuthPolicies_Delete

az afd auth-policy delete --resource-group RG --profile-name profile1 --auth-policy-name authPolicy1

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
--auth-policy-name --name -n

Name of the authorization policy under the profile.

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
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

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
--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 afd auth-policy list

Preview

Command group 'az afd auth-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List authorization policies associated with the profile.

az afd auth-policy list --profile-name
                        --resource-group
                        [--max-items]
                        [--next-token]

Examples

AuthPolicies_ListByProfile

az afd auth-policy list --resource-group RG --profile-name profile1

Required Parameters

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

--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 afd auth-policy show

Preview

Command group 'az afd auth-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get an existing authorization policy within a profile.

az afd auth-policy show [--auth-policy-name --name]
                        [--ids]
                        [--profile-name]
                        [--resource-group]
                        [--subscription]

Examples

AuthPolicies_Get

az afd auth-policy show --resource-group RG --profile-name profile1 --auth-policy-name authPolicy1

Optional Parameters

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

--auth-policy-name --name -n

Name of the authorization policy under the profile.

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
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

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 afd auth-policy update

Preview

Command group 'az afd auth-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an authorization policy within the specified profile.

az afd auth-policy update [--acquire-policy-token]
                          [--action {Block, Log}]
                          [--add]
                          [--associations]
                          [--auth-configs]
                          [--auth-policy-name --name]
                          [--change-reference]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--forward-token --forward-token-to-origin {0, 1, f, false, n, no, t, true, y, yes}]
                          [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--profile-name]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--subscription]

Examples

AuthPolicies_Create

az afd auth-policy update --resource-group RG --profile-name profile1 --auth-policy-name authPolicy1 --action Block --forward-token-to-origin True --associations "{domains:[{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1}],is-profile-level:False,routes:[{id:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1}]}" --auth-configs "[{entra-id:{audiences:[11111111-1111-1111-1111-111111111111],auth-location:Header,auth-location-selector:Authorization,issuer:'https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/v2.0'}}]"

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
--action

Action to apply when authorization fails.

Property Value
Parameter group: Properties Arguments
Accepted values: Block, Log
--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--associations

Resource associations for the authorization policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--auth-configs

Authorization configurations for the policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--auth-policy-name --name -n

Name of the authorization policy under the profile.

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
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--forward-token --forward-token-to-origin

Whether to forward the authentication token to the origin. Defaults to true.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

Property Value
Parameter group: Resource Id Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update 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
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update 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 afd auth-policy wait

Preview

Command group 'az afd auth-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az afd auth-policy wait [--acquire-policy-token]
                        [--auth-policy-name --name]
                        [--change-reference]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--profile-name]
                        [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--auth-policy-name --name -n

Name of the authorization policy under the profile.

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
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

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
--timeout

Maximum wait in seconds.

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