Operations - List

Service:

Support

API Version:

2020-04-01

This lists all the available Microsoft Support REST API operations.

GET https://management.azure.com/providers/Microsoft.Support/operations?api-version=2020-04-01

URI Parameters

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

Responses

Name	Type	Description
200 OK	OperationsListResult	Successfully retrieved list of operations.
Other Status Codes	ExceptionResponse	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

Get all operations

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Support/operations?api-version=2020-04-01

Java

/** Samples for Operations List. */
public final class Main {
    /*
     * x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/ListOperations.json
     */
    /**
     * Sample code: Get all operations.
     *
     * @param manager Entry point to SupportManager.
     */
    public static void getAllOperations(com.azure.resourcemanager.support.SupportManager manager) {
        manager.operations().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.support import MicrosoftSupport

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

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


# x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/ListOperations.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 armsupport_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/support/armsupport"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/ListOperations.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 := armsupport.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.OperationsListResult = armsupport.OperationsListResult{
		// 	Value: []*armsupport.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/services/read"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Gets all the Azure services available for support"),
		// 				Operation: to.Ptr("Reads Services"),
		// 				Provider: to.Ptr("Microsoft Support"),
		// 				Resource: to.Ptr("Service"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/problemClassifications/read"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Gets all the problem classifications available for a specific Azure service"),
		// 				Operation: to.Ptr("Reads Problem Classifications"),
		// 				Provider: to.Ptr("Microsoft Support"),
		// 				Resource: to.Ptr("Problem Classification"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/supportTickets/read"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Gets all the support tickets"),
		// 				Operation: to.Ptr("Reads Support Tickets"),
		// 				Provider: to.Ptr("Microsoft Support"),
		// 				Resource: to.Ptr("Support Ticket"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/supportTickets/write"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Updates support ticket"),
		// 				Operation: to.Ptr("Updates support ticket"),
		// 				Provider: to.Ptr("Microsoft Support"),
		// 				Resource: to.Ptr("Support Ticket"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/communications/read"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Gets all the communications"),
		// 				Operation: to.Ptr("Reads Communications"),
		// 				Provider: to.Ptr("Microsoft Support"),
		// 				Resource: to.Ptr("Communication"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/communications/write"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Creates a communication"),
		// 				Operation: to.Ptr("Creates a communication"),
		// 				Provider: to.Ptr("Microsoft Support"),
		// 				Resource: to.Ptr("Communication"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/register/action"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Registers Support Resource Provider"),
		// 				Operation: to.Ptr("Registers Support Resource Provider"),
		// 				Provider: to.Ptr("Registers Support Resource Provider"),
		// 				Resource: to.Ptr("Support Registration"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/createSupportTicket/action"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Creates support ticket"),
		// 				Operation: to.Ptr("Registers Support Resource Provider"),
		// 				Provider: to.Ptr("Microsoft Support"),
		// 				Resource: to.Ptr("SupportTicket"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Support/addCommunication/action"),
		// 			Display: &armsupport.OperationDisplay{
		// 				Description: to.Ptr("Add communication to support ticket"),
		// 				Operation: to.Ptr("Registers Support Resource Provider"),
		// 				Provider: to.Ptr("Microsoft Support"),
		// 				Resource: to.Ptr("Communication"),
		// 			},
		// 	}},
		// }
	}
}

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

/**
 * This sample demonstrates how to This lists all the available Microsoft Support REST API operations.
 *
 * @summary This lists all the available Microsoft Support REST API operations.
 * x-ms-original-file: specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/ListOperations.json
 */
async function getAllOperations() {
  const subscriptionId =
    process.env["SUPPORT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new MicrosoftSupport(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.Support/services/read",
      "display": {
        "description": "Gets all the Azure services available for support",
        "operation": "Reads Services",
        "provider": "Microsoft Support",
        "resource": "Service"
      }
    },
    {
      "name": "Microsoft.Support/problemClassifications/read",
      "display": {
        "description": "Gets all the problem classifications available for a specific Azure service",
        "operation": "Reads Problem Classifications",
        "provider": "Microsoft Support",
        "resource": "Problem Classification"
      }
    },
    {
      "name": "Microsoft.Support/supportTickets/read",
      "display": {
        "description": "Gets all the support tickets",
        "operation": "Reads Support Tickets",
        "provider": "Microsoft Support",
        "resource": "Support Ticket"
      }
    },
    {
      "name": "Microsoft.Support/supportTickets/write",
      "display": {
        "description": "Updates support ticket",
        "operation": "Updates support ticket",
        "provider": "Microsoft Support",
        "resource": "Support Ticket"
      }
    },
    {
      "name": "Microsoft.Support/communications/read",
      "display": {
        "description": "Gets all the communications",
        "operation": "Reads Communications",
        "provider": "Microsoft Support",
        "resource": "Communication"
      }
    },
    {
      "name": "Microsoft.Support/communications/write",
      "display": {
        "description": "Creates a communication",
        "operation": "Creates a communication",
        "provider": "Microsoft Support",
        "resource": "Communication"
      }
    },
    {
      "name": "Microsoft.Support/register/action",
      "display": {
        "description": "Registers Support Resource Provider",
        "operation": "Registers Support Resource Provider",
        "provider": "Registers Support Resource Provider",
        "resource": "Support Registration"
      }
    },
    {
      "name": "Microsoft.Support/createSupportTicket/action",
      "display": {
        "description": "Creates support ticket",
        "operation": "Registers Support Resource Provider",
        "provider": "Microsoft Support",
        "resource": "SupportTicket"
      }
    },
    {
      "name": "Microsoft.Support/addCommunication/action",
      "display": {
        "description": "Add communication to support ticket",
        "operation": "Registers Support Resource Provider",
        "provider": "Microsoft Support",
        "resource": "Communication"
      }
    }
  ]
}

Definitions

Name	Description
Display	The object that describes the operation.
ExceptionResponse	The API error.
Operation	The operation supported by Microsoft Support resource provider.
OperationsListResult	The list of operations supported by Microsoft Support resource provider.
ServiceError	The API error details.
ServiceErrorDetail	The error details.

Display

The object that describes the operation.

Name	Type	Description
description	string	The description of the operation.
operation	string	The action that users can perform, based on their permission level.
provider	string	Service provider: Microsoft Support.
resource	string	Resource on which the operation is performed.

ExceptionResponse

The API error.

Name	Type	Description
error	ServiceError	The API error details.

Operation

The operation supported by Microsoft Support resource provider.

Name	Type	Description
display	Display	The object that describes the operation.
name	string	Operation name: {provider}/{resource}/{operation}.

OperationsListResult

The list of operations supported by Microsoft Support resource provider.

Name	Type	Description
value	Operation[]	The list of operations supported by Microsoft Support resource provider.

ServiceError

The API error details.

Name	Type	Description
code	string	The error code.
details	ServiceErrorDetail[]	The list of error details.
message	string	The error message.
target	string	The target of the error.

ServiceErrorDetail

The error details.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the error.