Operations - List

Service:

Container Instances

API Version:

2023-05-01

List the operations for Azure Container Instance service.

GET https://management.azure.com/providers/Microsoft.ContainerInstance/operations?api-version=2023-05-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Client API version

Responses

Name	Type	Description
200 OK	OperationListResult	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

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

OperationsList

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.ContainerInstance/operations?api-version=2023-05-01

Java

/** Samples for Operations List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/
     * OperationsList.json
     */
    /**
     * Sample code: OperationsList.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void operationsList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.containerGroups().manager().serviceClient().getOperations().list(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.containerinstance import ContainerInstanceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerinstance
# USAGE
    python operations_list.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 = ContainerInstanceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.operations.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/OperationsList.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 armcontainerinstance_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerinstance/armcontainerinstance/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e60df62e9e0d88462e6abba81a76d94eab000f0d/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/OperationsList.json
func ExampleOperationsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerinstance.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OperationListResult = armcontainerinstance.OperationListResult{
		// 	Value: []*armcontainerinstance.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.ContainerInstance/containerGroups/read"),
		// 			Display: &armcontainerinstance.OperationDisplay{
		// 				Description: to.Ptr("Get all container goups."),
		// 				Operation: to.Ptr("Get Container Groups"),
		// 				Provider: to.Ptr("Microsoft Container Instance"),
		// 				Resource: to.Ptr("Container Group"),
		// 			},
		// 			Origin: to.Ptr(armcontainerinstance.ContainerInstanceOperationsOriginUser),
		// 	}},
		// }
	}
}

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 { ContainerInstanceManagementClient } = require("@azure/arm-containerinstance");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List the operations for Azure Container Instance service.
 *
 * @summary List the operations for Azure Container Instance service.
 * x-ms-original-file: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/OperationsList.json
 */
async function operationsList() {
  const subscriptionId =
    process.env["CONTAINERINSTANCE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new ContainerInstanceManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.operations.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "name": "Microsoft.ContainerInstance/containerGroups/read",
      "display": {
        "provider": "Microsoft Container Instance",
        "resource": "Container Group",
        "operation": "Get Container Groups",
        "description": "Get all container goups."
      },
      "origin": "User"
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the Container Instance service.
CloudErrorBody	An error response from the Container Instance service.
ContainerInstanceOperationsOrigin	The intended executor of the operation.
Display	The display information of the operation.
Operation	An operation for Azure Container Instance service.
OperationListResult	The operation list response that contains all operations for Azure Container Instance service.

CloudError

An error response from the Container Instance service.

Name	Type	Description
error	CloudErrorBody	An error response from the Container Instance service.

CloudErrorBody

An error response from the Container Instance service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ContainerInstanceOperationsOrigin

The intended executor of the operation.

Name	Type	Description
System	string
User	string

Display

The display information of the operation.

Name	Type	Description
description	string	The description of the operation.
operation	string	The friendly name of the operation.
provider	string	The name of the provider of the operation.
resource	string	The name of the resource type of the operation.

Operation

An operation for Azure Container Instance service.

Name	Type	Description
display	Display	The display information of the operation.
name	string	The name of the operation.
origin	ContainerInstanceOperationsOrigin	The intended executor of the operation.

OperationListResult

The operation list response that contains all operations for Azure Container Instance service.

Name	Type	Description
nextLink	string	The URI to fetch the next page of operations.
value	Operation[]	The list of operations.