client_application

Creates, updates, deletes, gets or lists a client_application resource.

Overview

Name	client_application
Type	Resource
Id	azure.api_management.client_application

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Client application description.
displayName	string	Client application name. Required.
entraApplicationId	string	Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created.
entraTenantId	string	Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services.
ownerId	string	A resource identifier for the user who owns the application. Required.
state	string	Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. Known values are: "pending", "active", "rejected", and "approved". (pending, active, rejected, approved)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Client application description.
displayName	string	Client application name. Required.
entraApplicationId	string	Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created.
entraTenantId	string	Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services.
ownerId	string	A resource identifier for the user who owns the application. Required.
state	string	Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. Known values are: "pending", "active", "rejected", and "approved". (pending, active, rejected, approved)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, client_application_id, subscription_id		Gets the details of the client application specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists a collection of client applications in the specified service instance.
create_or_update	insert	resource_group_name, service_name, client_application_id, subscription_id		Creates or Updates a client application.
create_or_update	replace	resource_group_name, service_name, client_application_id, subscription_id		Creates or Updates a client application.
delete	delete	resource_group_name, service_name, client_application_id, subscription_id		Delete client application.
get_entity_tag	exec	resource_group_name, service_name, client_application_id, subscription_id		Gets the entity state (Etag) version of the product specified by its identifier.
list_secrets	exec	resource_group_name, service_name, client_application_id, subscription_id		Retrived client application secrets.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
client_application_id	string	Client Application identifier. Must be unique in the current API Management service instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | state | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith ||. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the details of the client application specified by its identifier.

SELECT
id,
name,
description,
displayName,
entraApplicationId,
entraTenantId,
ownerId,
state,
systemData,
type
FROM azure.api_management.client_application
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND client_application_id = '{{ client_application_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists a collection of client applications in the specified service instance.

SELECT
id,
name,
description,
displayName,
entraApplicationId,
entraTenantId,
ownerId,
state,
systemData,
type
FROM azure.api_management.client_application
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates or Updates a client application.

INSERT INTO azure.api_management.client_application (
properties,
resource_group_name,
service_name,
client_application_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ client_application_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: client_application
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the client_application resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the client_application resource.
  - name: client_application_id
    value: "{{ client_application_id }}"
    description: Required parameter for the client_application resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the client_application resource.
  - name: properties
    description: |
      Client application entity contract properties.
    value:
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      ownerId: "{{ ownerId }}"
      entraApplicationId: "{{ entraApplicationId }}"
      entraTenantId: "{{ entraTenantId }}"
      state: "{{ state }}"

REPLACE examples

create_or_update

Creates or Updates a client application.

REPLACE azure.api_management.client_application
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND client_application_id = '{{ client_application_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete client application.

DELETE FROM azure.api_management.client_application
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND client_application_id = '{{ client_application_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the product specified by its identifier.

EXEC azure.api_management.client_application.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@client_application_id='{{ client_application_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_secrets

Retrived client application secrets.

EXEC azure.api_management.client_application.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@client_application_id='{{ client_application_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;