Api Operation - List By Api

Referentie

Service:: API Management

API-versie:: 2024-05-01

Geeft een verzameling van de bewerkingen voor de opgegeven API weer.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?api-version=2024-05-01

Met optionele parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?$filter={$filter}&$top={$top}&$skip={$skip}&tags={tags}&api-version=2024-05-01

URI-parameters

Name	In	Vereist	Type	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	\| Veld \| Gebruik \| Ondersteunde operators \| Ondersteunde functies \| \|-------------\|-------------\|-------------\|-------------\| \| naam \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| displayName \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| methode \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| beschrijving \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \| \| urlTemplate \| filter \| ge, le, eq, ne, gt, lt \| subtekenreeks, bevat, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	Het aantal records dat moet worden overgeslagen.
$top	query		integer (int32) minimum: 1	Aantal records dat moet worden geretourneerd.
tags	query		string	Neem tags op in het antwoord.

Antwoorden

Name	Type	Description
200 OK	OperationCollection	Een verzameling samenvattingsentiteiten voor bewerkingen op API-niveau.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementListApiOperations

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations?api-version=2024-05-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "displayName": "CancelOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cda",
      "properties": {
        "displayName": "GetMostRecentOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd9",
      "properties": {
        "displayName": "GetOpenOrders",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdb",
      "properties": {
        "displayName": "GetOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd8",
      "properties": {
        "displayName": "submitOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder"
      }
    }
  ],
  "count": 5,
  "nextLink": ""
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
OperationCollection	Weergave van lijst met paginabewerkingen.
OperationContract	Api-bewerkingsgegevens.
ParameterContract	Details van bewerkingsparameters.
ParameterExampleContract	Parametervoorbeeld.
RepresentationContract	Details van weergave van bewerkingsaanvraag/antwoord.
RequestContract	Details van bewerkingsaanvraag.
ResponseContract	Details van bewerkingsreactie.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

OperationCollection

Object

Weergave van lijst met paginabewerkingen.

Name	Type	Description
count	integer (int64)	Totaal aantal records voor alle pagina's.
nextLink	string	Koppeling naar volgende pagina indien aanwezig.
value	OperationContract[]	Paginawaarden.

OperationContract

Object

Api-bewerkingsgegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.description	string maxLength: 1000	Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten.
properties.displayName	string minLength: 1 maxLength: 300	Bewerkingsnaam.
properties.method	string	Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden.
properties.policies	string	Bewerkingsbeleid
properties.request	RequestContract	Een entiteit met aanvraaggegevens.
properties.responses	ResponseContract[]	Matrix van bewerkingsreacties.
properties.templateParameters	ParameterContract[]	Verzameling url-sjabloonparameters.
properties.urlTemplate	string minLength: 1 maxLength: 1000	Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date}
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ParameterContract

Object

Details van bewerkingsparameters.

Name	Type	Description
defaultValue	string	Standaardparameterwaarde.
description	string	Parameterbeschrijving.
examples	<string, ParameterExampleContract>	Voorbeeld gedefinieerd voor de parameter.
name	string	Parameternaam.
required	boolean	Hiermee geeft u op of parameter is vereist of niet.
schemaId	string	Schema-id.
type	string	Parametertype.
typeName	string	Typ de naam die is gedefinieerd door het schema.
values	string[]	Parameterwaarden.

ParameterExampleContract

Object

Parametervoorbeeld.

Name	Type	Description
description	string	Lange beschrijving voor het voorbeeld
externalValue	string	Een URL die verwijst naar het letterlijke voorbeeld
summary	string	Korte beschrijving voor het voorbeeld
value		Voorbeeldwaarde. Dit kan een primitieve waarde of een object zijn.

RepresentationContract

Object

Details van weergave van bewerkingsaanvraag/antwoord.

Name	Type	Description
contentType	string	Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml.
examples	<string, ParameterExampleContract>	Voorbeeld gedefinieerd voor de weergave.
formParameters	ParameterContract[]	Verzameling formulierparameters. Vereist als de waarde 'contentType' 'application/x-www-form-urlencoded' of 'multipart/form-data' is.
schemaId	string	Schema-id. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is.
typeName	string	Typ de naam die is gedefinieerd door het schema. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is.

RequestContract

Object

Details van bewerkingsaanvraag.

Name	Type	Description
description	string	Beschrijving van bewerkingsaanvraag.
headers	ParameterContract[]	Verzameling aanvraagheaders voor bewerkingen.
queryParameters	ParameterContract[]	Verzameling queryparameters voor bewerkingsaanvragen.
representations	RepresentationContract[]	Verzameling weergaven van bewerkingsaanvragen.

ResponseContract

Object

Details van bewerkingsreactie.

Name	Type	Description
description	string	Beschrijving van het antwoord van de bewerking.
headers	ParameterContract[]	Verzameling antwoordheaders voor bewerkingen.
representations	RepresentationContract[]	Verzameling weergaven van bewerkingsreacties.
statusCode	integer (int32)	HTTP-statuscode van het bewerkingsantwoord.

Delen via

Api Operation - List By Api

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementListApiOperations

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OperationCollection

OperationContract

ParameterContract

ParameterExampleContract

RepresentationContract

RequestContract

ResponseContract

Aanvullende resources