Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. ClientApplication
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.ClientApplication

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

    Client application details.

    Uses Azure REST API version 2024-10-01-preview.

    Example Usage

    ApiManagementCreateProduct

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var clientApplication = new AzureNative.ApiManagement.ClientApplication("clientApplication", new()
    {
        ClientApplicationId = "testAppId",
        Description = "This is just an example application",
        DisplayName = "Test Application",
        OwnerId = "/users/userId",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
    });

});

    package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewClientApplication(ctx, "clientApplication", &apimanagement.ClientApplicationArgs{
			ClientApplicationId: pulumi.String("testAppId"),
			Description:         pulumi.String("This is just an example application"),
			DisplayName:         pulumi.String("Test Application"),
			OwnerId:             pulumi.String("/users/userId"),
			ResourceGroupName:   pulumi.String("rg1"),
			ServiceName:         pulumi.String("apimService1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.ClientApplication;
import com.pulumi.azurenative.apimanagement.ClientApplicationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var clientApplication = new ClientApplication("clientApplication", ClientApplicationArgs.builder()
            .clientApplicationId("testAppId")
            .description("This is just an example application")
            .displayName("Test Application")
            .ownerId("/users/userId")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const clientApplication = new azure_native.apimanagement.ClientApplication("clientApplication", {
    clientApplicationId: "testAppId",
    description: "This is just an example application",
    displayName: "Test Application",
    ownerId: "/users/userId",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});

    import pulumi
import pulumi_azure_native as azure_native

client_application = azure_native.apimanagement.ClientApplication("clientApplication",
    client_application_id="testAppId",
    description="This is just an example application",
    display_name="Test Application",
    owner_id="/users/userId",
    resource_group_name="rg1",
    service_name="apimService1")

    resources:
  clientApplication:
    type: azure-native:apimanagement:ClientApplication
    properties:
      clientApplicationId: testAppId
      description: This is just an example application
      displayName: Test Application
      ownerId: /users/userId
      resourceGroupName: rg1
      serviceName: apimService1

    Create ClientApplication Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClientApplication(name: string, args: ClientApplicationArgs, opts?: CustomResourceOptions);
    @overload
def ClientApplication(resource_name: str,
                      args: ClientApplicationArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ClientApplication(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      display_name: Optional[str] = None,
                      owner_id: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      client_application_id: Optional[str] = None,
                      description: Optional[str] = None)
    func NewClientApplication(ctx *Context, name string, args ClientApplicationArgs, opts ...ResourceOption) (*ClientApplication, error)
    public ClientApplication(string name, ClientApplicationArgs args, CustomResourceOptions? opts = null)
    public ClientApplication(String name, ClientApplicationArgs args)
public ClientApplication(String name, ClientApplicationArgs args, CustomResourceOptions options)

    type: azure-native:apimanagement:ClientApplication
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClientApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClientApplicationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClientApplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientApplicationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clientApplicationResource = new AzureNative.ApiManagement.ClientApplication("clientApplicationResource", new()
{
    DisplayName = "string",
    OwnerId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    ClientApplicationId = "string",
    Description = "string",
});

    example, err := apimanagement.NewClientApplication(ctx, "clientApplicationResource", &apimanagement.ClientApplicationArgs{
	DisplayName:         pulumi.String("string"),
	OwnerId:             pulumi.String("string"),
	ResourceGroupName:   pulumi.String("string"),
	ServiceName:         pulumi.String("string"),
	ClientApplicationId: pulumi.String("string"),
	Description:         pulumi.String("string"),
})

    var clientApplicationResource = new ClientApplication("clientApplicationResource", ClientApplicationArgs.builder()
    .displayName("string")
    .ownerId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .clientApplicationId("string")
    .description("string")
    .build());

    client_application_resource = azure_native.apimanagement.ClientApplication("clientApplicationResource",
    display_name="string",
    owner_id="string",
    resource_group_name="string",
    service_name="string",
    client_application_id="string",
    description="string")

    const clientApplicationResource = new azure_native.apimanagement.ClientApplication("clientApplicationResource", {
    displayName: "string",
    ownerId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    clientApplicationId: "string",
    description: "string",
});

    type: azure-native:apimanagement:ClientApplication
properties:
    clientApplicationId: string
    description: string
    displayName: string
    ownerId: string
    resourceGroupName: string
    serviceName: string

    ClientApplication Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ClientApplication resource accepts the following input properties:

    DisplayName string
    Client application name.
    OwnerId string
    A resource identifier for the user who owns the application.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ClientApplicationId string
    Client Application identifier. Must be unique in the current API Management service instance.
    Description string
    Client application description.
    DisplayName string
    Client application name.
    OwnerId string
    A resource identifier for the user who owns the application.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ClientApplicationId string
    Client Application identifier. Must be unique in the current API Management service instance.
    Description string
    Client application description.
    displayName String
    Client application name.
    ownerId String
    A resource identifier for the user who owns the application.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    clientApplicationId String
    Client Application identifier. Must be unique in the current API Management service instance.
    description String
    Client application description.
    displayName string
    Client application name.
    ownerId string
    A resource identifier for the user who owns the application.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    clientApplicationId string
    Client Application identifier. Must be unique in the current API Management service instance.
    description string
    Client application description.
    display_name str
    Client application name.
    owner_id str
    A resource identifier for the user who owns the application.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    client_application_id str
    Client Application identifier. Must be unique in the current API Management service instance.
    description str
    Client application description.
    displayName String
    Client application name.
    ownerId String
    A resource identifier for the user who owns the application.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    clientApplicationId String
    Client Application identifier. Must be unique in the current API Management service instance.
    description String
    Client application description.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClientApplication resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    State string
    Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    State string
    Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    state String
    Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    state string
    Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    entra_application_id str
    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.
    entra_tenant_id str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    state str
    Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    state String
    Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:ClientApplication testAppId /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
    pulumi/pulumi-azure-native