Share via

az apim deletedservice

Manage soft-deleted Azure API Management services.

Commands

Name Description Type Status
az apim deletedservice list

List all soft-deleted Api Management services instances available for undelete for the given subscription.

 Core GA
az apim deletedservice purge

Purge soft-deleted Api Management service instance (deletes it with no option to undelete).

 Core GA
az apim deletedservice show

Get soft-deleted Api Management service instances available for undelete by name.

 Core GA

az apim deletedservice list

Edit

List all soft-deleted Api Management services instances available for undelete for the given subscription.

az apim deletedservice list

Examples

List all soft-deleted services in a subscription.

az apim deletedservice list
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 apim deletedservice purge

Edit

Purge soft-deleted Api Management service instance (deletes it with no option to undelete).

az apim deletedservice purge --location
                             --service-name

Examples

Purge a soft-deleted serivce.

az apim deletedservice purge --service-name MyApim --location westus

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--service-name -n

The name of the soft deleted API Management service instance.

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 apim deletedservice show

Edit

Get soft-deleted Api Management service instances available for undelete by name.

az apim deletedservice show --location
                            --service-name

Examples

Get a soft-deleted services with its name.

az apim deletedservice show --service-name MyApim --location westus

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--service-name -n

The name of the soft deleted API Management service instance.

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