Operations - List

Service:

PostgreSQL

API Version:

2017-12-01

Listy wszystkich dostępnych operacji interfejsu API REST.

GET https://management.azure.com/providers/Microsoft.DBforPostgreSQL/operations?api-version=2017-12-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OperationListResult	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

OperationList

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.DBforPostgreSQL/operations?api-version=2017-12-01

Java

import com.azure.core.util.Context;

/** Samples for Operations List. */
public final class Main {
    /*
     * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/OperationList.json
     */
    /**
     * Sample code: OperationList.
     *
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void operationList(com.azure.resourcemanager.postgresql.PostgreSqlManager manager) {
        manager.operations().listWithResponse(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.rdbms.postgresql import PostgreSQLManagementClient

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

    response = client.operations.list()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/OperationList.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 armpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/OperationList.json
func ExampleOperationsClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsClient().List(ctx, 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.OperationListResult = armpostgresql.OperationListResult{
	// 	Value: []*armpostgresql.Operation{
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/locations/performanceTiers/read"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Returns the list of Performance Tiers available."),
	// 				Operation: to.Ptr("List Performance Tiers"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("Performance Tiers"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/read"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Return the list of servers or gets the properties for the specified server."),
	// 				Operation: to.Ptr("List/Get PostgreSQL Servers"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("PostgreSQL Server"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/write"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Creates a server with the specified parameters or update the properties or tags for the specified server."),
	// 				Operation: to.Ptr("Create/Update PostgreSQL Server"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("PostgreSQL Server"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/delete"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Deletes an existing server."),
	// 				Operation: to.Ptr("Delete PostgreSQL Server"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("PostgreSQL Server"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/performanceTiers/read"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Returns the list of Performance Tiers available."),
	// 				Operation: to.Ptr("List Performance Tiers"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("Performance Tiers"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/firewallRules/read"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Return the list of firewall rules for a server or gets the properties for the specified firewall rule."),
	// 				Operation: to.Ptr("List/Get Firewall Rules"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("Firewall Rules"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/firewallRules/write"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Creates a firewall rule with the specified parameters or update an existing rule."),
	// 				Operation: to.Ptr("Create/Update Firewall Rule"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("Firewall Rules"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/firewallRules/delete"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Deletes an existing firewall rule."),
	// 				Operation: to.Ptr("Delete Firewall Rule"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("Firewall Rules"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/providers/Microsoft.Insights/metricDefinitions/read"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Return types of metrics that are available for databases"),
	// 				Operation: to.Ptr("Get database metric definitions"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("Database Metric Definition"),
	// 			},
	// 			Properties: map[string]any{
	// 				"serviceSpecification": map[string]any{
	// 					"metricSpecifications":[]any{
	// 						map[string]any{
	// 							"name": "cpu_percent",
	// 							"aggregationType": "Average",
	// 							"displayDescription": "CPU percent",
	// 							"displayName": "CPU percent",
	// 							"fillGapWithZero": true,
	// 							"unit": "Percent",
	// 						},
	// 						map[string]any{
	// 							"name": "memory_percent",
	// 							"aggregationType": "Average",
	// 							"displayDescription": "Memory percent",
	// 							"displayName": "Memory percent",
	// 							"fillGapWithZero": true,
	// 							"unit": "Percent",
	// 						},
	// 						map[string]any{
	// 							"name": "io_consumption_percent",
	// 							"aggregationType": "Average",
	// 							"displayDescription": "IO percent",
	// 							"displayName": "IO percent",
	// 							"fillGapWithZero": true,
	// 							"unit": "Percent",
	// 						},
	// 						map[string]any{
	// 							"name": "storage_percent",
	// 							"aggregationType": "Average",
	// 							"displayDescription": "Storage percentage",
	// 							"displayName": "Storage percentage",
	// 							"unit": "Percent",
	// 						},
	// 						map[string]any{
	// 							"name": "storage_used",
	// 							"aggregationType": "Average",
	// 							"displayDescription": "Storage used",
	// 							"displayName": "Storage used",
	// 							"unit": "Bytes",
	// 						},
	// 						map[string]any{
	// 							"name": "storage_limit",
	// 							"aggregationType": "Average",
	// 							"displayDescription": "Storage limit",
	// 							"displayName": "Storage limit",
	// 							"unit": "Bytes",
	// 						},
	// 						map[string]any{
	// 							"name": "active_connections",
	// 							"aggregationType": "Average",
	// 							"displayDescription": "Total active connections",
	// 							"displayName": "Total active connections",
	// 							"fillGapWithZero": true,
	// 							"unit": "Count",
	// 						},
	// 						map[string]any{
	// 							"name": "connections_failed",
	// 							"aggregationType": "Average",
	// 							"displayDescription": "Total failed connections",
	// 							"displayName": "Total failed connections",
	// 							"fillGapWithZero": true,
	// 							"unit": "Count",
	// 						},
	// 					},
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/providers/Microsoft.Insights/diagnosticSettings/read"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Gets the disagnostic setting for the resource"),
	// 				Operation: to.Ptr("Read diagnostic setting"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("Database Metric Definition"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.DBforPostgreSQL/servers/providers/Microsoft.Insights/diagnosticSettings/write"),
	// 			Display: &armpostgresql.OperationDisplay{
	// 				Description: to.Ptr("Creates or updates the diagnostic setting for the resource"),
	// 				Operation: to.Ptr("Write diagnostic setting"),
	// 				Provider: to.Ptr("Microsoft DB for PostgreSQL"),
	// 				Resource: to.Ptr("Database Metric Definition"),
	// 			},
	// 	}},
	// }
}

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

/**
 * This sample demonstrates how to Lists all of the available REST API operations.
 *
 * @summary Lists all of the available REST API operations.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/OperationList.json
 */
async function operationList() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementClient(credential, subscriptionId);
  const result = await client.operations.list();
  console.log(result);
}

operationList().catch(console.error);

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.DBforPostgreSQL/locations/performanceTiers/read",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "Performance Tiers",
        "operation": "List Performance Tiers",
        "description": "Returns the list of Performance Tiers available."
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/read",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "PostgreSQL Server",
        "operation": "List/Get PostgreSQL Servers",
        "description": "Return the list of servers or gets the properties for the specified server."
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/write",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "PostgreSQL Server",
        "operation": "Create/Update PostgreSQL Server",
        "description": "Creates a server with the specified parameters or update the properties or tags for the specified server."
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/delete",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "PostgreSQL Server",
        "operation": "Delete PostgreSQL Server",
        "description": "Deletes an existing server."
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/performanceTiers/read",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "Performance Tiers",
        "operation": "List Performance Tiers",
        "description": "Returns the list of Performance Tiers available."
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/firewallRules/read",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "Firewall Rules",
        "operation": "List/Get Firewall Rules",
        "description": "Return the list of firewall rules for a server or gets the properties for the specified firewall rule."
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/firewallRules/write",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "Firewall Rules",
        "operation": "Create/Update Firewall Rule",
        "description": "Creates a firewall rule with the specified parameters or update an existing rule."
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/firewallRules/delete",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "Firewall Rules",
        "operation": "Delete Firewall Rule",
        "description": "Deletes an existing firewall rule."
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/providers/Microsoft.Insights/metricDefinitions/read",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "Database Metric Definition",
        "operation": "Get database metric definitions",
        "description": "Return types of metrics that are available for databases"
      },
      "properties": {
        "serviceSpecification": {
          "metricSpecifications": [
            {
              "name": "cpu_percent",
              "displayName": "CPU percent",
              "displayDescription": "CPU percent",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "memory_percent",
              "displayName": "Memory percent",
              "displayDescription": "Memory percent",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "io_consumption_percent",
              "displayName": "IO percent",
              "displayDescription": "IO percent",
              "unit": "Percent",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "storage_percent",
              "displayName": "Storage percentage",
              "displayDescription": "Storage percentage",
              "unit": "Percent",
              "aggregationType": "Average"
            },
            {
              "name": "storage_used",
              "displayName": "Storage used",
              "displayDescription": "Storage used",
              "unit": "Bytes",
              "aggregationType": "Average"
            },
            {
              "name": "storage_limit",
              "displayName": "Storage limit",
              "displayDescription": "Storage limit",
              "unit": "Bytes",
              "aggregationType": "Average"
            },
            {
              "name": "active_connections",
              "displayName": "Total active connections",
              "displayDescription": "Total active connections",
              "unit": "Count",
              "aggregationType": "Average",
              "fillGapWithZero": true
            },
            {
              "name": "connections_failed",
              "displayName": "Total failed connections",
              "displayDescription": "Total failed connections",
              "unit": "Count",
              "aggregationType": "Average",
              "fillGapWithZero": true
            }
          ]
        }
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/providers/Microsoft.Insights/diagnosticSettings/read",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "Database Metric Definition",
        "operation": "Read diagnostic setting",
        "description": "Gets the disagnostic setting for the resource"
      }
    },
    {
      "name": "Microsoft.DBforPostgreSQL/servers/providers/Microsoft.Insights/diagnosticSettings/write",
      "display": {
        "provider": "Microsoft DB for PostgreSQL",
        "resource": "Database Metric Definition",
        "operation": "Write diagnostic setting",
        "description": "Creates or updates the diagnostic setting for the resource"
      }
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi Batch.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
Operation	Definicja operacji interfejsu API REST.
OperationDisplay	Wyświetl metadane skojarzone z operacją.
OperationListResult	Lista operacji dostawcy zasobów.
OperationOrigin	Zamierzony wykonawca operacji.

CloudError

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

Operation

Definicja operacji interfejsu API REST.

Nazwa	Typ	Opis
display	OperationDisplay	Zlokalizowane informacje wyświetlane dla tej konkretnej operacji lub akcji.
name	string	Nazwa operacji wykonywanej na tym konkretnym obiekcie.
origin	OperationOrigin	Zamierzony wykonawca operacji.
properties	object	Dodatkowe opisy operacji.

OperationDisplay

Wyświetl metadane skojarzone z operacją.

Nazwa	Typ	Opis
description	string	Opis operacji.
operation	string	Zlokalizowana przyjazna nazwa operacji.
provider	string	Nazwa dostawcy zasobów operacji.
resource	string	Zasób, na którym wykonywana jest operacja.

OperationListResult

Lista operacji dostawcy zasobów.

Nazwa	Typ	Opis
value	Operation[]	Lista operacji dostawcy zasobów.

OperationOrigin

Zamierzony wykonawca operacji.

Nazwa	Typ	Opis
NotSpecified	string
system	string
user	string