Delen via

Global Schema - List By Service

  • Referentie
Service:
API Management
API-versie:
2021-08-01

Een lijst met een verzameling schema's die zijn geregistreerd bij het service-exemplaar.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas?api-version=2021-08-01
Met optionele parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep.
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

Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version
 query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag.
$filter
 query

string

| Veld | Gebruik | Ondersteunde operators | Ondersteunde functies |
|-------------|-------------|-------------|-------------|
| naam | 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.

Antwoorden

Name Type Description
200 OK

GlobalSchemaCollection

Geeft een verzameling schema-entiteiten weer.
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

ApiManagementListSchemas

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas?api-version=2021-08-01

Voorbeeldrespons

Statuscode:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1",
      "type": "Microsoft.ApiManagement/service/schemas",
      "name": "schema1",
      "properties": {
        "description": "sample schema description",
        "schemaType": "xml",
        "value": "<xsd:schema xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\r\n           xmlns:tns=\"http://tempuri.org/PurchaseOrderSchema.xsd\"\r\n           targetNamespace=\"http://tempuri.org/PurchaseOrderSchema.xsd\"\r\n           elementFormDefault=\"qualified\">\r\n <xsd:element name=\"PurchaseOrder\" type=\"tns:PurchaseOrderType\"/>\r\n <xsd:complexType name=\"PurchaseOrderType\">\r\n  <xsd:sequence>\r\n   <xsd:element name=\"ShipTo\" type=\"tns:USAddress\" maxOccurs=\"2\"/>\r\n   <xsd:element name=\"BillTo\" type=\"tns:USAddress\"/>\r\n  </xsd:sequence>\r\n  <xsd:attribute name=\"OrderDate\" type=\"xsd:date\"/>\r\n </xsd:complexType>\r\n\r\n <xsd:complexType name=\"USAddress\">\r\n  <xsd:sequence>\r\n   <xsd:element name=\"name\"   type=\"xsd:string\"/>\r\n   <xsd:element name=\"street\" type=\"xsd:string\"/>\r\n   <xsd:element name=\"city\"   type=\"xsd:string\"/>\r\n   <xsd:element name=\"state\"  type=\"xsd:string\"/>\r\n   <xsd:element name=\"zip\"    type=\"xsd:integer\"/>\r\n  </xsd:sequence>\r\n  <xsd:attribute name=\"country\" type=\"xsd:NMTOKEN\" fixed=\"US\"/>\r\n </xsd:complexType>\r\n</xsd:schema>"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2",
      "type": "Microsoft.ApiManagement/service/schemas",
      "name": "schema2",
      "properties": {
        "description": "sample schema description",
        "schemaType": "json",
        "document": {
          "$id": "https://example.com/person.schema.json",
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "title": "Person",
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string",
              "description": "The person's first name."
            },
            "lastName": {
              "type": "string",
              "description": "The person's last name."
            },
            "age": {
              "description": "Age in years which must be equal to or greater than zero.",
              "type": "integer",
              "minimum": 0
            }
          }
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definities

Name Description
ErrorFieldContract

Foutveldcontract.
ErrorResponse

Foutreactie.
GlobalSchemaCollection

Het antwoord van de lijstschemabewerking.
GlobalSchemaContract

Algemene schemacontractgegevens.
SchemaType

Schematype. Onveranderlijk.

ErrorFieldContract

Object

Foutveldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.
message

string

Leesbare weergave van fout op eigenschapsniveau.
target

string

Eigenschapsnaam.

ErrorResponse

Object

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details

ErrorFieldContract[]

De lijst met ongeldige velden die in de aanvraag worden verzonden, in het geval van een validatiefout.
error.message

string

Leesbare weergave van de fout.

GlobalSchemaCollection

Object

Het antwoord van de lijstschemabewerking.

Name Type Description
count

integer (int64)

Totaal aantal records.
nextLink

string

Koppeling naar volgende pagina indien aanwezig.
value

GlobalSchemaContract[]

Globale waarde schemacontract.

GlobalSchemaContract

Object

Algemene schemacontractgegevens.

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

Beschrijving van vrije schema-entiteit.
properties.schemaType

SchemaType

Schematype. Onveranderlijk.
properties.value

Json-gecodeerde tekenreeks voor niet-json-schema.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SchemaType

Inventarisatie

Schematype. Onveranderlijk.

Waarde Description
json

Json-schematype.
xml

Xml-schematype.