Share via

az graph-services account

Note

This reference is part of the graphservices extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an az graph-services account command. Learn more about extensions.

Make operations on Microsoft.GraphServices/Accounts.

Commands

Name Description Type Status
az graph-services account create

Create account resource. Enables billing for the provided application.

 Extension GA
az graph-services account delete

Delete an account resource. Disables billing on the associated application.

 Extension GA
az graph-services account list

List of accounts belonging to a subscription.

 Extension GA
az graph-services account show

Get an account resource given its name.

 Extension GA
az graph-services account update

Update an account resource.

 Extension GA
az graph-services account wait

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

 Extension GA

az graph-services account create

Create account resource. Enables billing for the provided application.

az graph-services account create --app-id
                                 --name --resource-name
                                 --resource-group
                                 [--location]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--tags]

Examples

Create Account

az graph-services account create --resource-group myRG  --resource-name myGraphAppBilling --subscription mySubscriptionGUID --location global --tags "foo=bar" "baz=qux" --app-id myAppGUID

Required Parameters

--app-id

Customer owned application ID.

Property Value
Parameter group: Properties Arguments
--name --resource-name -n

The name of the resource.

--resource-group -g

Name of an Azure resource group in your subscription.

Optional Parameters

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

--location -l

Location of the resource.

Property Value
Parameter group: AccountResource Arguments
Default value: global
--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
--tags

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

Property Value
Parameter group: AccountResource 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 graph-services account delete

Delete an account resource. Disables billing on the associated application.

az graph-services account delete [--ids]
                                 [--name --resource-name]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

Examples

Delete account

az graph-services account delete --subscription mySubscriptionGUID --resource-group myRG --resource-name myGraphAppBilling

Optional Parameters

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

--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
--name --resource-name -n

The name of the resource.

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

Name of an Azure resource group in your subscription.

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 graph-services account list

List of accounts belonging to a subscription.

az graph-services account list [--resource-group]

Examples

List resources in subscription

az graph-services account list --subscription mySubscriptionGUID --resource-group myRg

Optional Parameters

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

--resource-group -g

Name of an Azure resource group in your subscription.

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 graph-services account show

Get an account resource given its name.

az graph-services account show [--ids]
                               [--name --resource-name]
                               [--resource-group]
                               [--subscription]

Examples

Get account

az --subscription mySubscriptionGUID --resource-group myRG --resource-name myGraphAppBilling

Optional Parameters

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

--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
--name --resource-name -n

The name of the resource.

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

Name of an Azure resource group in your subscription.

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 graph-services account update

Update an account resource.

The only supported updated on a resource is the tags property.

az graph-services account update [--add]
                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--ids]
                                 [--location]
                                 [--name --resource-name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--remove]
                                 [--resource-group]
                                 [--set]
                                 [--subscription]
                                 [--tags]

Examples

Update account

az graph-services account update --resource-group myRG --resource-name myGraphAppBilling --subscription mySubscriptionGUID --location global --tags "foo1=bar1" "baz1=qux1"

Optional Parameters

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

--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
--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
--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
--location -l

Location of the resource.

Property Value
Parameter group: AccountResource Arguments
--name --resource-name -n

The name of the resource.

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
--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 an Azure resource group in your subscription.

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

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

Property Value
Parameter group: AccountResource 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 graph-services account wait

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

az graph-services account wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name --resource-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.

--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
--name --resource-name -n

The name of the resource.

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

Name of an Azure resource group in your subscription.

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