Container Apps Revision Replicas - Get Replica

Service:

Azure Container Apps

API Version:

2024-03-01

Get a replica for a Container App Revision.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{replicaName}?api-version=2024-03-01

URI Parameters

Name	In	Required	Type	Description
containerAppName	path	True	string	Name of the Container App.
replicaName	path	True	string	Name of the Container App Revision Replica.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
revisionName	path	True	string	Name of the Container App Revision.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Replica	OK
Other Status Codes	DefaultErrorResponse	Common error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get Container App's revision replica

Sample request

HTTP

GET https://management.azure.com/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8?api-version=2024-03-01

Java

/**
 * Samples for ContainerAppsRevisionReplicas GetReplica.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Replicas_Get.json
     */
    /**
     * Sample code: Get Container App's revision replica.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void
        getContainerAppSRevisionReplica(com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.containerAppsRevisionReplicas().getReplicaWithResponse("workerapps-rg-xj", "myapp", "myapp--0wlqy09",
            "myapp--0wlqy09-5d9774cff-5wnd8", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcontainers import ContainerAppsAPIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python replicas_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="651f8027-33e8-4ec4-97b4-f6e9f3dc8744",
    )

    response = client.container_apps_revision_replicas.get_replica(
        resource_group_name="workerapps-rg-xj",
        container_app_name="myapp",
        revision_name="myapp--0wlqy09",
        replica_name="myapp--0wlqy09-5d9774cff-5wnd8",
    )
    print(response)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Replicas_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappcontainers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edf14cc0a577f6b9c4e3ce018cec0c383e64b7b0/specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Replicas_Get.json
func ExampleContainerAppsRevisionReplicasClient_GetReplica() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewContainerAppsRevisionReplicasClient().GetReplica(ctx, "workerapps-rg-xj", "myapp", "myapp--0wlqy09", "myapp--0wlqy09-5d9774cff-5wnd8", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Replica = armappcontainers.Replica{
	// 	Name: to.Ptr("myapp--0wlqy09-5d9774cff-5wnd8"),
	// 	Type: to.Ptr("Microsoft.Web/containerapps/revisions/replicas"),
	// 	ID: to.Ptr("/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8"),
	// 	Properties: &armappcontainers.ReplicaProperties{
	// 		Containers: []*armappcontainers.ReplicaContainer{
	// 			{
	// 				Name: to.Ptr("hello92"),
	// 				ContainerID: to.Ptr("containerd://6bac7bb3afed1c704b5fe563c34c0ecf59ac30c766bb73488f7fa552dc42ee54"),
	// 				ExecEndpoint: to.Ptr("testExecEndpoint"),
	// 				LogStreamEndpoint: to.Ptr("testLogStreamEndpoint"),
	// 				Ready: to.Ptr(true),
	// 				RestartCount: to.Ptr[int32](0),
	// 				RunningState: to.Ptr(armappcontainers.ContainerAppContainerRunningStateRunning),
	// 				RunningStateDetails: to.Ptr("testDetail"),
	// 				Started: to.Ptr(true),
	// 		}},
	// 		CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-25T19:42:45.000Z"); return t}()),
	// 		InitContainers: []*armappcontainers.ReplicaContainer{
	// 		},
	// 		RunningState: to.Ptr(armappcontainers.ContainerAppReplicaRunningStateRunning),
	// 		RunningStateDetails: to.Ptr("testDetail"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ContainerAppsAPIClient } = require("@azure/arm-appcontainers");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a replica for a Container App Revision.
 *
 * @summary Get a replica for a Container App Revision.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Replicas_Get.json
 */
async function getContainerAppRevisionReplica() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "651f8027-33e8-4ec4-97b4-f6e9f3dc8744";
  const resourceGroupName = process.env["APPCONTAINERS_RESOURCE_GROUP"] || "workerapps-rg-xj";
  const containerAppName = "myapp";
  const revisionName = "myapp--0wlqy09";
  const replicaName = "myapp--0wlqy09-5d9774cff-5wnd8";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const result = await client.containerAppsRevisionReplicas.getReplica(
    resourceGroupName,
    containerAppName,
    revisionName,
    replicaName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppContainers;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Replicas_Get.json
// this example is just showing the usage of "ContainerAppsRevisionReplicas_GetReplica" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ContainerAppRevisionResource created on azure
// for more information of creating ContainerAppRevisionResource, please refer to the document of ContainerAppRevisionResource
string subscriptionId = "651f8027-33e8-4ec4-97b4-f6e9f3dc8744";
string resourceGroupName = "workerapps-rg-xj";
string containerAppName = "myapp";
string revisionName = "myapp--0wlqy09";
ResourceIdentifier containerAppRevisionResourceId = ContainerAppRevisionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, containerAppName, revisionName);
ContainerAppRevisionResource containerAppRevision = client.GetContainerAppRevisionResource(containerAppRevisionResourceId);

// get the collection of this ContainerAppReplicaResource
ContainerAppReplicaCollection collection = containerAppRevision.GetContainerAppReplicas();

// invoke the operation
string replicaName = "myapp--0wlqy09-5d9774cff-5wnd8";
NullableResponse<ContainerAppReplicaResource> response = await collection.GetIfExistsAsync(replicaName);
ContainerAppReplicaResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ContainerAppReplicaData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8",
  "name": "myapp--0wlqy09-5d9774cff-5wnd8",
  "type": "Microsoft.Web/containerapps/revisions/replicas",
  "properties": {
    "createdTime": "2022-01-25T19:42:45Z",
    "runningState": "Running",
    "runningStateDetails": "testDetail",
    "containers": [
      {
        "name": "hello92",
        "containerId": "containerd://6bac7bb3afed1c704b5fe563c34c0ecf59ac30c766bb73488f7fa552dc42ee54",
        "ready": true,
        "started": true,
        "restartCount": 0,
        "runningState": "Running",
        "runningStateDetails": "testDetail",
        "logStreamEndpoint": "testLogStreamEndpoint",
        "execEndpoint": "testExecEndpoint"
      }
    ],
    "initContainers": []
  }
}

Definitions

Name	Description
ContainerAppContainerRunningState	Current running state of the container
ContainerAppReplicaRunningState	Current running state of the replica
createdByType	The type of identity that created the resource.
DefaultErrorResponse	App Service error response.
Details	Details or the error
Error	Error model.
Replica	Container App Revision Replica.
ReplicaContainer	Container object under Container App Revision Replica.
systemData	Metadata pertaining to creation and last modification of the resource.

ContainerAppContainerRunningState

Current running state of the container

Name	Type	Description
Running	string
Terminated	string
Waiting	string

ContainerAppReplicaRunningState

Current running state of the replica

Name	Type	Description
NotRunning	string
Running	string
Unknown	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Details or the error

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Details or the error
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Replica

Container App Revision Replica.

Name	Type	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
properties.containers	ReplicaContainer[]	The containers collection under a replica.
properties.createdTime	string	Timestamp describing when the pod was created by controller
properties.initContainers	ReplicaContainer[]	The init containers collection under a replica.
properties.runningState	ContainerAppReplicaRunningState	Current running state of the replica
properties.runningStateDetails	string	The details of replica current running state
systemData	systemData	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"

ReplicaContainer

Container object under Container App Revision Replica.

Name	Type	Description
containerId	string	The Id of the Container
execEndpoint	string	Container exec endpoint
logStreamEndpoint	string	Log Stream endpoint
name	string	The Name of the Container
ready	boolean	The container ready status
restartCount	integer	The container restart count
runningState	ContainerAppContainerRunningState	Current running state of the container
runningStateDetails	string	The details of container current running state
started	boolean	The container start status

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.