Operations - List

Reference

Service:: Relay

API Version:: 2021-11-01

Lists all available Relay REST API operations.

GET https://management.azure.com/providers/Microsoft.Relay/operations?api-version=2021-11-01

URI Parameters

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

Responses

Name	Type	Description
200 OK	OperationListResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Relay 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

RelayOperationsList

Sample Request

GET https://management.azure.com/providers/Microsoft.Relay/operations?api-version=2021-11-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.relay import RelayAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-relay
# USAGE
    python relay_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 = RelayAPI(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/RelayOperations_List.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

package armrelay_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/RelayOperations_List.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 := armrelay.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 = armrelay.OperationListResult{
		// 	Value: []*armrelay.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/checkNameAvailability/action"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Get namespace availability."),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Non Resource Operation"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/register/action"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Registers the Relay Resource Provider"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Relay Resource Provider"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/write"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Create Or Update Namespace "),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Namespace"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/read"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Get Namespace Resource"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Namespace"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/Delete"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Delete Namespace"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Namespace"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/Relays/write"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Relay"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Relay"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/Relays/read"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Get Relay"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Relay"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/Relays/Delete"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Delete Relay"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Relay"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/metricDefinitions/read"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Get Namespace metrics"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Namespace metrics"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/diagnosticSettings/read"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Get Namespace diagnostic settings"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Namespace diagnostic settings"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/diagnosticSettings/write"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Create or Update Namespace diagnostic settings"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Namespace diagnostic settings"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Relay/namespaces/logDefinitions/read"),
		// 			Display: &armrelay.OperationDisplay{
		// 				Operation: to.Ptr("Get Namespace logs"),
		// 				Provider: to.Ptr("Microsoft Azure Relay"),
		// 				Resource: to.Ptr("Namespace logs"),
		// 			},
		// 	}},
		// }
	}
}

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.Relay/checkNameAvailability/action",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Non Resource Operation",
        "operation": "Get namespace availability."
      }
    },
    {
      "name": "Microsoft.Relay/register/action",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Relay Resource Provider",
        "operation": "Registers the Relay Resource Provider"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/write",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Namespace",
        "operation": "Create Or Update Namespace "
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/read",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Namespace",
        "operation": "Get Namespace Resource"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/Delete",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Namespace",
        "operation": "Delete Namespace"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/Relays/write",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Relay",
        "operation": "Create or Update Relay"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/Relays/read",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Relay",
        "operation": "Get Relay"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/Relays/Delete",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Relay",
        "operation": "Delete Relay"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/metricDefinitions/read",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Namespace metrics",
        "operation": "Get Namespace metrics"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/diagnosticSettings/read",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Namespace diagnostic settings",
        "operation": "Get Namespace diagnostic settings"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/diagnosticSettings/write",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Namespace diagnostic settings",
        "operation": "Create or Update Namespace diagnostic settings"
      }
    },
    {
      "name": "Microsoft.Relay/namespaces/logDefinitions/read",
      "display": {
        "provider": "Microsoft Azure Relay",
        "resource": "Namespace logs",
        "operation": "Get Namespace logs"
      }
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Operation	A Relay REST API operation
OperationDisplay	Operation display payload
OperationListResult	Result of the request to list Relay operations. It contains a list of operations and a URL link to get the next set of results.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Operation

A Relay REST API operation

Name	Type	Description
display	OperationDisplay	Display of the operation
isDataAction	boolean	Indicates whether the operation is a data action
name	string	Operation name: {provider}/{resource}/{operation}
origin	string	Origin of the operation

OperationDisplay

Operation display payload

Name	Type	Description
description	string	Localized friendly description for the operation
operation	string	Localized friendly name for the operation
provider	string	Resource provider of the operation
resource	string	Resource of the operation

OperationListResult

Result of the request to list Relay operations. It contains a list of operations and a URL link to get the next set of results.

Name	Type	Description
nextLink	string	URL to get the next set of operation list results if there are any.
value	Operation[]	List of Relay operations supported by the Microsoft.Relay resource provider.

Share via