Megosztás a következőn keresztül:


Apis - Create Or Update

Létrehoz egy új vagy frissíti a API Management szolgáltatáspéldány meglévő megadott API-ját.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2022-08-01

URI-paraméterek

Name In Kötelező Típus Description
apiId
path True

string

API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

Reguláris kifejezési minta: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.

serviceName
path True

string

A API Management szolgáltatás neve.

Reguláris kifejezési minta: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

A cél-előfizetés azonosítója.

api-version
query True

string

A művelethez használandó API-verzió.

Kérelem fejléce

Name Kötelező Típus Description
If-Match

string

Az entitás ETagje. Entitás létrehozásakor nem kötelező, de az entitások frissítésekor kötelező.

Kérelem törzse

Name Kötelező Típus Description
properties.path True

string

Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát a API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végponti alap URL-címhez, hogy nyilvános URL-címet hozzon létre ehhez az API-hoz.

apiRevision

string

Az API felülvizsgálatát ismerteti. Ha nincs megadva érték, az alapértelmezett 1. változat jön létre

apiRevisionDescription

string

Az API-változat leírása.

apiVersion

string

Az API verzióazonosítóját jelzi, ha az API verziószámozott

apiVersionDescription

string

Az API-verzió leírása.

apiVersionSetId

string

A kapcsolódó ApiVersionSet erőforrás-azonosítója.

authenticationSettings

AuthenticationSettingsContract

Az API hitelesítési beállításainak gyűjteménye.

contact

ApiContactInformation

Az API kapcsolattartási adatai.

description

string

Az API leírása. Html-formázási címkéket is tartalmazhat.

isCurrent

boolean

Azt jelzi, hogy az API-változat aktuális API-változat-e.

license

ApiLicenseInformation

Licencinformációk az API-hoz.

properties.apiType

SoapApiType

A létrehozandó API típusa.

  • http REST API-t hoz létre
  • soap SOAP átmenő API-t hoz létre
  • websocket websocket API létrehozása
  • graphql GraphQL API-t hoz létre.
properties.apiVersionSet

ApiVersionSetContractDetails

Verziókészlet részletei

properties.displayName

string

API neve. 1–300 karakter hosszúságúnak kell lennie.

properties.format

ContentFormat

Annak a tartalomnak a formátuma, amelyben az API importálása történik.

properties.protocols

Protocol[]

Ez a cikk azt ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

properties.serviceUrl

string

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszúságú lehet.

properties.sourceApiId

string

A forrás API API-azonosítója.

properties.translateRequiredQueryParameters

TranslateRequiredQueryParametersConduct

A szükséges lekérdezési paraméterek sablonra fordításának stratégiája. Alapértelmezés szerint a "template" érték van megadva. Lehetséges értékek: 'template', 'query'

properties.value

string

Tartalomérték API importálásakor.

properties.wsdlSelector

WsdlSelector

A WSDL importálásának a dokumentum egy részhalmazára való korlátozására vonatkozó feltételek.

subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokollok, amelyeken keresztül az API elérhetővé válik.

subscriptionRequired

boolean

Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez.

termsOfServiceUrl

string

Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie.

type

ApiType

Az API típusa.

Válaszok

Name Típus Description
200 OK

ApiContract

Az API frissítése sikerült.

Fejlécek

ETag: string

201 Created

ApiContract

Az API létrehozása sikerült.

Fejlécek

ETag: string

202 Accepted

Az API létrehozására vagy frissítésére vonatkozó kérés el lett fogadva. A hely fejléce tartalmazza azt az URL-címet, ahol a hosszú ideig futó művelet állapota ellenőrizhető.

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

ApiManagementCreateApi
ApiManagementCreateApiClone
ApiManagementCreateApiNewVersionUsingExistingApi
ApiManagementCreateApiRevisionFromExistingApi
ApiManagementCreateApiUsingImportOverrideServiceUrl
ApiManagementCreateApiUsingOai3Import
ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct
ApiManagementCreateApiUsingSwaggerImport
ApiManagementCreateApiUsingWadlImport
ApiManagementCreateApiWithMultipleAuthServers
ApiManagementCreateApiWithMultipleOpenIdConnectProviders
ApiManagementCreateApiWithOpenIdConnect
ApiManagementCreateGraphQLApi
ApiManagementCreateSoapPassThroughApiUsingWsdlImport
ApiManagementCreateSoapToRestApiUsingWsdlImport
ApiManagementCreateWebSocketApi

ApiManagementCreateApi

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01

{
  "properties": {
    "description": "apidescription5200",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      }
    },
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "displayName": "apiname1463",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "https",
      "http"
    ]
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "http",
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "isCurrent": true,
    "isOnline": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "http",
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementCreateApiClone

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api2?api-version=2022-08-01

{
  "properties": {
    "displayName": "Echo API2",
    "description": "Copy of Existing Echo Api including Operations.",
    "subscriptionRequired": true,
    "serviceUrl": "http://echoapi.cloudapp.net/api",
    "path": "echo2",
    "protocols": [
      "http",
      "https"
    ],
    "isCurrent": true,
    "sourceApiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001"
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echoapi2",
  "properties": {
    "displayName": "Echo API2",
    "apiRevision": "1",
    "description": "Copy of Existing Echo Api including Operations.",
    "subscriptionRequired": true,
    "serviceUrl": "http://echoapi.cloudapp.net/api",
    "path": "echo2",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echoapi2",
  "properties": {
    "displayName": "Echo API2",
    "apiRevision": "1",
    "description": "Copy of Existing Echo Api including Operations.",
    "subscriptionRequired": true,
    "serviceUrl": "http://echoapi.cloudapp.net/api",
    "path": "echo2",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

ApiManagementCreateApiNewVersionUsingExistingApi

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3?api-version=2022-08-01

{
  "properties": {
    "displayName": "Echo API2",
    "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.",
    "subscriptionRequired": true,
    "serviceUrl": "http://echoapi.cloudapp.net/api",
    "path": "echo2",
    "protocols": [
      "http",
      "https"
    ],
    "isCurrent": true,
    "apiVersion": "v4",
    "sourceApiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath",
    "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458"
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echoapiv3",
  "properties": {
    "displayName": "Echo API2",
    "apiRevision": "1",
    "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.",
    "subscriptionRequired": true,
    "serviceUrl": "http://echoapi.cloudapp.net/api",
    "path": "echo2",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "apiVersion": "v4",
    "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458",
    "apiVersionSet": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458",
      "name": "Echo API2",
      "versioningScheme": "Segment"
    }
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echoapiv3",
  "properties": {
    "displayName": "Echo API2",
    "apiRevision": "1",
    "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.",
    "subscriptionRequired": true,
    "serviceUrl": "http://echoapi.cloudapp.net/api",
    "path": "echo2",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "apiVersion": "v4",
    "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458",
    "apiVersionSet": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458",
      "name": "Echo API2",
      "versioningScheme": "Segment"
    }
  }
}

ApiManagementCreateApiRevisionFromExistingApi

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2022-08-01

{
  "properties": {
    "path": "echo",
    "serviceUrl": "http://echoapi.cloudapp.net/apiv3",
    "sourceApiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
    "apiRevisionDescription": "Creating a Revision of an existing API"
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Echo API",
    "apiRevision": "3",
    "subscriptionRequired": true,
    "serviceUrl": "http://echoapi.cloudapp.net/apiv3",
    "path": "echo",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "Creating a Revision of an existing API"
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Echo API",
    "apiRevision": "3",
    "subscriptionRequired": true,
    "serviceUrl": "http://echoapi.cloudapp.net/apiv3",
    "path": "echo",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "Creating a Revision of an existing API"
  }
}

ApiManagementCreateApiUsingImportOverrideServiceUrl

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2022-08-01

{
  "properties": {
    "format": "swagger-link",
    "value": "http://apimpimportviaurl.azurewebsites.net/api/apidocs/",
    "path": "petstoreapi123",
    "serviceUrl": "http://petstore.swagger.wordnik.com/api"
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apidocs",
  "properties": {
    "displayName": "Swagger Sample App",
    "apiRevision": "1",
    "description": "This is a sample server Petstore server.  You can find out more about Swagger \n    at <a href=\"http://swagger.wordnik.com\">http://swagger.wordnik.com</a> or on irc.freenode.net, #swagger.  For this sample,\n    you can use the api key \"special-key\" to test the authorization filters",
    "serviceUrl": "http://petstore.swagger.wordnik.com/api",
    "path": "petstoreapi123",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apidocs",
  "properties": {
    "displayName": "Swagger Sample App",
    "apiRevision": "1",
    "description": "This is a sample server Petstore server.  You can find out more about Swagger \n    at <a href=\"http://swagger.wordnik.com\">http://swagger.wordnik.com</a> or on irc.freenode.net, #swagger.  For this sample,\n    you can use the api key \"special-key\" to test the authorization filters",
    "serviceUrl": "http://petstore.swagger.wordnik.com/api",
    "path": "petstoreapi123",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

ApiManagementCreateApiUsingOai3Import

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstore?api-version=2022-08-01

{
  "properties": {
    "format": "openapi-link",
    "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml",
    "path": "petstore"
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "petstoreapi",
  "properties": {
    "displayName": "Swagger Petstore",
    "apiRevision": "1",
    "serviceUrl": "http://petstore.swagger.io/v1",
    "path": "petstore",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "petstoreapi",
  "properties": {
    "displayName": "Swagger Petstore",
    "apiRevision": "1",
    "serviceUrl": "http://petstore.swagger.io/v1",
    "path": "petstore",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstore?api-version=2022-08-01

{
  "properties": {
    "format": "openapi-link",
    "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml",
    "path": "petstore",
    "translateRequiredQueryParameters": "template"
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "petstoreapi",
  "properties": {
    "displayName": "Swagger Petstore",
    "apiRevision": "1",
    "serviceUrl": "http://petstore.swagger.io/v1",
    "path": "petstore",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "petstoreapi",
  "properties": {
    "displayName": "Swagger Petstore",
    "apiRevision": "1",
    "serviceUrl": "http://petstore.swagger.io/v1",
    "path": "petstore",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

ApiManagementCreateApiUsingSwaggerImport

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstore?api-version=2022-08-01

{
  "properties": {
    "format": "swagger-link-json",
    "value": "http://petstore.swagger.io/v2/swagger.json",
    "path": "petstore"
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "petstoreapi",
  "properties": {
    "displayName": "Swagger Petstore",
    "apiRevision": "1",
    "description": "This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.",
    "serviceUrl": "http://petstore.swagger.io/v2",
    "path": "petstore",
    "protocols": [
      "http"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "petstoreapi",
  "properties": {
    "displayName": "Swagger Petstore",
    "apiRevision": "1",
    "description": "This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.",
    "serviceUrl": "http://petstore.swagger.io/v2",
    "path": "petstore",
    "protocols": [
      "http"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

ApiManagementCreateApiUsingWadlImport

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstore?api-version=2022-08-01

{
  "properties": {
    "format": "wadl-link-json",
    "value": "https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl",
    "path": "collector"
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "collectorwadl",
  "properties": {
    "displayName": "http://localhost:8080/collector-northbound",
    "apiRevision": "1",
    "description": "",
    "serviceUrl": "http://localhost:8080/collector-northbound",
    "path": "collector",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "collectorwadl",
  "properties": {
    "displayName": "http://localhost:8080/collector-northbound",
    "apiRevision": "1",
    "description": "",
    "serviceUrl": "http://localhost:8080/collector-northbound",
    "path": "collector",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

ApiManagementCreateApiWithMultipleAuthServers

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01

{
  "properties": {
    "description": "apidescription5200",
    "authenticationSettings": {
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "displayName": "apiname1463",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "https",
      "http"
    ]
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "isCurrent": true,
    "isOnline": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "http",
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementCreateApiWithMultipleOpenIdConnectProviders

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01

{
  "properties": {
    "description": "apidescription5200",
    "authenticationSettings": {
      "openidAuthenticationSettings": [
        {
          "openidProviderId": "openidProviderId2283",
          "bearerTokenSendingMethods": [
            "authorizationHeader"
          ]
        },
        {
          "openidProviderId": "openidProviderId2284",
          "bearerTokenSendingMethods": [
            "authorizationHeader"
          ]
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "displayName": "apiname1463",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "https",
      "http"
    ]
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "isCurrent": true,
    "isOnline": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "http://newechoapi.cloudapp.net/api",
    "path": "newapiPath",
    "protocols": [
      "http",
      "https"
    ],
    "authenticationSettings": {
      "openid": {
        "openidProviderId": "openidProviderId2283",
        "bearerTokenSendingMethods": [
          "authorizationHeader"
        ]
      },
      "openidAuthenticationSettings": [
        {
          "openidProviderId": "openidProviderId2283",
          "bearerTokenSendingMethods": [
            "authorizationHeader"
          ]
        },
        {
          "openidProviderId": "openidProviderId2284",
          "bearerTokenSendingMethods": [
            "authorizationHeader"
          ]
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementCreateApiWithOpenIdConnect

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01

{
  "properties": {
    "displayName": "Swagger Petstore",
    "description": "This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.",
    "serviceUrl": "http://petstore.swagger.io/v2",
    "path": "petstore",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "openid": {
        "openidProviderId": "testopenid",
        "bearerTokenSendingMethods": [
          "authorizationHeader"
        ]
      }
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    }
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "58da4c4ccdae970a08121230",
  "properties": {
    "displayName": "Swagger Petstore",
    "apiRevision": "1",
    "description": "This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.",
    "serviceUrl": "http://petstore.swagger.io/v2",
    "path": "petstore",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "openid": {
        "openidProviderId": "testopenid",
        "bearerTokenSendingMethods": [
          "authorizationHeader"
        ]
      }
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "58da4c4ccdae970a08121230",
  "properties": {
    "displayName": "Swagger Petstore",
    "apiRevision": "1",
    "description": "This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.",
    "serviceUrl": "http://petstore.swagger.io/v2",
    "path": "petstore",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "openid": {
        "openidProviderId": "testopenid",
        "bearerTokenSendingMethods": [
          "authorizationHeader"
        ]
      }
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

ApiManagementCreateGraphQLApi

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01

{
  "properties": {
    "description": "apidescription5200",
    "displayName": "apiname1463",
    "type": "graphql",
    "serviceUrl": "https://api.spacex.land/graphql",
    "path": "graphql-api",
    "protocols": [
      "http",
      "https"
    ]
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "https://api.spacex.land/graphql",
    "type": "graphql",
    "path": "graphql-api",
    "protocols": [
      "https",
      "https"
    ],
    "authenticationSettings": null,
    "subscriptionKeyParameterNames": null,
    "isCurrent": true,
    "isOnline": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "https://api.spacex.land/graphql",
    "type": "graphql",
    "path": "graphql-api",
    "protocols": [
      "http",
      "https"
    ],
    "authenticationSettings": null,
    "subscriptionKeyParameterNames": null,
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementCreateSoapPassThroughApiUsingWsdlImport

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi?api-version=2022-08-01

{
  "properties": {
    "format": "wsdl-link",
    "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
    "path": "currency",
    "apiType": "soap",
    "wsdlSelector": {
      "wsdlServiceName": "CurrencyConvertor",
      "wsdlEndpointName": "CurrencyConvertorSoap"
    }
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "soapApi",
  "properties": {
    "displayName": "CurrencyConvertor",
    "apiRevision": "1",
    "serviceUrl": "http://www.webservicex.net",
    "path": "currency",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "soapApi",
  "properties": {
    "displayName": "CurrencyConvertor",
    "apiRevision": "1",
    "serviceUrl": "http://www.webservicex.net",
    "path": "currency",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true
  }
}

ApiManagementCreateSoapToRestApiUsingWsdlImport

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi?api-version=2022-08-01

{
  "properties": {
    "format": "wsdl-link",
    "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
    "path": "currency",
    "wsdlSelector": {
      "wsdlServiceName": "CurrencyConvertor",
      "wsdlEndpointName": "CurrencyConvertorSoap"
    }
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "soapApi",
  "properties": {
    "displayName": "CurrencyConvertor",
    "apiRevision": "1",
    "serviceUrl": "http://www.webservicex.net",
    "path": "currency",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "soapApi",
  "properties": {
    "displayName": "CurrencyConvertor",
    "apiRevision": "1",
    "serviceUrl": "http://www.webservicex.net",
    "path": "currency",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

ApiManagementCreateWebSocketApi

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01

{
  "properties": {
    "description": "apidescription5200",
    "displayName": "apiname1463",
    "type": "websocket",
    "serviceUrl": "wss://echo.websocket.org",
    "path": "newapiPath",
    "protocols": [
      "wss",
      "ws"
    ]
  }
}

Mintaválasz

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "wss://echo.websocket.org",
    "type": "websocket",
    "path": "newapiPath",
    "protocols": [
      "ws",
      "wss"
    ],
    "authenticationSettings": null,
    "subscriptionKeyParameterNames": null,
    "isCurrent": true,
    "isOnline": true
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "apiid9419",
  "properties": {
    "displayName": "apiname1463",
    "apiRevision": "1",
    "description": "apidescription5200",
    "serviceUrl": "wss://echo.websocket.org",
    "type": "websocket",
    "path": "newapiPath",
    "protocols": [
      "ws",
      "wss"
    ],
    "authenticationSettings": null,
    "subscriptionKeyParameterNames": null,
    "isCurrent": true,
    "isOnline": true
  }
}

Definíciók

Name Description
ApiContactInformation

API-kapcsolatfelvételi adatok

ApiContract

API-részletek.

ApiCreateOrUpdateParameter

API-létrehozási vagy -frissítési paraméterek.

ApiLicenseInformation

API-licencinformációk

ApiType

Az API típusa.

ApiVersionSetContractDetails

Az API-verziókészlet tartalmazza a kapcsolódó API-verziók halmazának gyakori konfigurációját

AuthenticationSettingsContract

API-hitelesítési beállítások.

bearerTokenSendingMethods

Jogkivonat küldése a kiszolgálóra.

ContentFormat

Annak a tartalomnak a formátuma, amelyben az API importálása történik.

ErrorFieldContract

Hibamező-szerződés.

ErrorResponse

Hibaválasz.

OAuth2AuthenticationSettingsContract

API OAuth2 Hitelesítési beállítások részletei.

OpenIdAuthenticationSettingsContract

API OAuth2 Hitelesítési beállítások részletei.

Protocol

Ez a cikk azt ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

SoapApiType

A létrehozandó API típusa.

  • http REST API-t hoz létre
  • soap SOAP átmenő API-t hoz létre
  • websocket websocket API létrehozása
  • graphql GraphQL API-t hoz létre.
SubscriptionKeyParameterNamesContract

Az előfizetési kulcs paraméterneveinek részletei.

TranslateRequiredQueryParametersConduct

A szükséges lekérdezési paraméterek sablonra fordításának stratégiája. Alapértelmezés szerint a "template" érték van megadva. Lehetséges értékek: 'template', 'query'

versioningScheme

Egy érték, amely meghatározza, hogy az API-verzió azonosítója hol található egy HTTP-kérelemben.

WsdlSelector

A WSDL importálásának a dokumentum egy részhalmazára való korlátozására vonatkozó feltételek.

ApiContactInformation

API-kapcsolatfelvételi adatok

Name Típus Description
email

string

A kapcsolattartó/szervezet e-mail-címe. E-mail-cím formátumban kell lennie

name

string

A kapcsolattartó/szervezet azonosító neve

url

string

A kapcsolattartási adatokra mutató URL-cím. URL-cím formátumban kell lennie

ApiContract

API-részletek.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Az erőforrás neve

properties.apiRevision

string

Az API felülvizsgálatát ismerteti. Ha nincs megadva érték, az alapértelmezett 1. változat jön létre

properties.apiRevisionDescription

string

Az API-változat leírása.

properties.apiVersion

string

Az API verzióazonosítóját jelzi, ha az API verziószámozott

properties.apiVersionDescription

string

Az API-verzió leírása.

properties.apiVersionSet

ApiVersionSetContractDetails

Verziókészlet részletei

properties.apiVersionSetId

string

A kapcsolódó ApiVersionSet erőforrás-azonosítója.

properties.authenticationSettings

AuthenticationSettingsContract

Az API hitelesítési beállításainak gyűjteménye.

properties.contact

ApiContactInformation

Az API kapcsolattartási adatai.

properties.description

string

Az API leírása. Html-formázási címkéket is tartalmazhat.

properties.displayName

string

API neve. 1–300 karakter hosszúságúnak kell lennie.

properties.isCurrent

boolean

Azt jelzi, hogy az API-változat aktuális API-változat-e.

properties.isOnline

boolean

Azt jelzi, hogy az API-változat elérhető-e az átjárón keresztül.

properties.license

ApiLicenseInformation

Licencinformációk az API-hoz.

properties.path

string

Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát a API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végponti alap URL-címhez, hogy nyilvános URL-címet hozzon létre ehhez az API-hoz.

properties.protocols

Protocol[]

Ez a cikk azt ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

properties.serviceUrl

string

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszúságú lehet.

properties.sourceApiId

string

A forrás API API-azonosítója.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokollok, amelyeken keresztül az API elérhetővé válik.

properties.subscriptionRequired

boolean

Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez.

properties.termsOfServiceUrl

string

Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie.

properties.type

ApiType

Az API típusa.

type

string

Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ApiCreateOrUpdateParameter

API-létrehozási vagy -frissítési paraméterek.

Name Típus Description
apiRevision

string

Az API felülvizsgálatát ismerteti. Ha nincs megadva érték, az alapértelmezett 1. változat jön létre

apiRevisionDescription

string

Az API-változat leírása.

apiVersion

string

Az API verzióazonosítóját jelzi, ha az API verziószámozott

apiVersionDescription

string

Az API-verzió leírása.

apiVersionSetId

string

A kapcsolódó ApiVersionSet erőforrás-azonosítója.

authenticationSettings

AuthenticationSettingsContract

Az API hitelesítési beállításainak gyűjteménye.

contact

ApiContactInformation

Az API kapcsolattartási adatai.

description

string

Az API leírása. Html-formázási címkéket is tartalmazhat.

isCurrent

boolean

Azt jelzi, hogy az API-változat aktuális API-változat-e.

isOnline

boolean

Azt jelzi, hogy az API-változat elérhető-e az átjárón keresztül.

license

ApiLicenseInformation

Licencinformációk az API-hoz.

properties.apiType

SoapApiType

A létrehozandó API típusa.

  • http REST API-t hoz létre
  • soap SOAP átmenő API-t hoz létre
  • websocket websocket API létrehozása
  • graphql GraphQL API-t hoz létre.
properties.apiVersionSet

ApiVersionSetContractDetails

Verziókészlet részletei

properties.displayName

string

API neve. 1–300 karakter hosszúságúnak kell lennie.

properties.format

ContentFormat

Annak a tartalomnak a formátuma, amelyben az API importálása történik.

properties.path

string

Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát a API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végponti alap URL-címhez, hogy nyilvános URL-címet hozzon létre ehhez az API-hoz.

properties.protocols

Protocol[]

Ez a cikk azt ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

properties.serviceUrl

string

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszúságú lehet.

properties.sourceApiId

string

A forrás API API-azonosítója.

properties.translateRequiredQueryParameters

TranslateRequiredQueryParametersConduct

A szükséges lekérdezési paraméterek sablonra fordításának stratégiája. Alapértelmezés szerint a "template" érték van megadva. Lehetséges értékek: 'template', 'query'

properties.value

string

Tartalomérték API importálásakor.

properties.wsdlSelector

WsdlSelector

A WSDL importálásának a dokumentum egy részhalmazára való korlátozására vonatkozó feltételek.

subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokollok, amelyeken keresztül az API elérhetővé válik.

subscriptionRequired

boolean

Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez.

termsOfServiceUrl

string

Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie.

type

ApiType

Az API típusa.

ApiLicenseInformation

API-licencinformációk

Name Típus Description
name

string

Az API-hoz használt licencnév

url

string

Az API-hoz használt licenc URL-címe. URL-cím formátumban kell lennie

ApiType

Az API típusa.

Name Típus Description
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

Az API-verziókészlet tartalmazza a kapcsolódó API-verziók halmazának gyakori konfigurációját

Name Típus Description
description

string

Az API-verziókészlet leírása.

id

string

A meglévő API-verziókészlet azonosítója. Ezt az értéket kihagyva hozzon létre egy új verziókészletet.

name

string

A megjelenített API-verziókészlet neve.

versionHeaderName

string

Annak a HTTP-fejlécparaméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értékre headervan állítva.

versionQueryName

string

Annak a lekérdezési paraméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értékre queryvan állítva.

versioningScheme

versioningScheme

Egy érték, amely meghatározza, hogy az API-verzió azonosítója hol található egy HTTP-kérelemben.

AuthenticationSettingsContract

API-hitelesítési beállítások.

Name Típus Description
oAuth2

OAuth2AuthenticationSettingsContract

Az OAuth2 hitelesítési beállításai

oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

Az API részét képező OAuth2 hitelesítési beállítások gyűjteménye.

openid

OpenIdAuthenticationSettingsContract

OpenID Connect-hitelesítési beállítások

openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

Az API-hoz tartozó Open ID Connect hitelesítési beállítások gyűjteménye.

bearerTokenSendingMethods

Jogkivonat küldése a kiszolgálóra.

Name Típus Description
authorizationHeader

string

A hozzáférési jogkivonat az Engedélyezési fejlécben lesz továbbítva a Tulajdonos sémája használatával

query

string

A hozzáférési jogkivonat lekérdezési paraméterekként lesz továbbítva.

ContentFormat

Annak a tartalomnak a formátuma, amelyben az API importálása történik.

Name Típus Description
graphql-link

string

A GraphQL API-végpont nyilvánosan elérhető internetcímen fut.

openapi

string

A tartalom beágyazott, a Tartalomtípus pedig egy OpenAPI 3.0 YAML-dokumentum.

openapi+json

string

A tartalom beágyazott, a Tartalomtípus pedig egy OpenAPI 3.0 JSON-dokumentum.

openapi+json-link

string

Az OpenAPI 3.0 JSON-dokumentum egy nyilvánosan elérhető internetes címen található.

openapi-link

string

Az OpenAPI 3.0 YAML-dokumentum egy nyilvánosan elérhető internetes címen található.

swagger-json

string

A tartalom beágyazott, a Tartalomtípus pedig egy OpenAPI 2.0 JSON-dokumentum.

swagger-link-json

string

Az OpenAPI 2.0 JSON-dokumentum egy nyilvánosan elérhető internetes címen található.

wadl-link-json

string

A WADL-dokumentum egy nyilvánosan elérhető internetes címen található.

wadl-xml

string

A tartalom beágyazott, a Tartalomtípus pedig WADL-dokumentum.

wsdl

string

A tartalom beágyazott, a dokumentum pedig egy WSDL-/Soap-dokumentum.

wsdl-link

string

A WSDL-dokumentum egy nyilvánosan elérhető internetes címen található.

ErrorFieldContract

Hibamező-szerződés.

Name Típus Description
code

string

Tulajdonságszintű hibakód.

message

string

A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.

target

string

Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name Típus Description
error.code

string

Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.

error.details

ErrorFieldContract[]

Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája.

error.message

string

A hiba emberi olvasásra alkalmas ábrázolása.

OAuth2AuthenticationSettingsContract

API OAuth2 Hitelesítési beállítások részletei.

Name Típus Description
authorizationServerId

string

OAuth engedélyezési kiszolgáló azonosítója.

scope

string

műveleti hatókör.

OpenIdAuthenticationSettingsContract

API OAuth2 Hitelesítési beállítások részletei.

Name Típus Description
bearerTokenSendingMethods

bearerTokenSendingMethods[]

Jogkivonat küldése a kiszolgálóra.

openidProviderId

string

OAuth engedélyezési kiszolgáló azonosítója.

Protocol

Ez a cikk azt ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

Name Típus Description
http

string

https

string

ws

string

wss

string

SoapApiType

A létrehozandó API típusa.

  • http REST API-t hoz létre
  • soap SOAP átmenő API-t hoz létre
  • websocket websocket API létrehozása
  • graphql GraphQL API-t hoz létre.
Name Típus Description
graphql

string

Importálja a GraphQL előtérrendszerrel rendelkező API-t.

http

string

Importál egy RESTful előtérrel rendelkező SOAP API-t.

soap

string

Importálja a SOAP előtérrel rendelkező SOAP API-t.

websocket

string

Importálja a Websocket előtérrendszerrel rendelkező API-t.

SubscriptionKeyParameterNamesContract

Az előfizetési kulcs paraméterneveinek részletei.

Name Típus Description
header

string

Előfizetési kulcs fejlécének neve.

query

string

Előfizetési kulcs lekérdezési sztring paraméterének neve.

TranslateRequiredQueryParametersConduct

A szükséges lekérdezési paraméterek sablonra fordításának stratégiája. Alapértelmezés szerint a "template" érték van megadva. Lehetséges értékek: 'template', 'query'

Name Típus Description
query

string

A szükséges lekérdezési paramétereket a megadott módon hagyja meg (a fordítás nem történik meg).

template

string

Lefordítja a szükséges lekérdezési paramétereket sablonra. Alapértelmezett érték

versioningScheme

Egy érték, amely meghatározza, hogy az API-verzió azonosítója hol található egy HTTP-kérelemben.

Name Típus Description
Header

string

Az API-verzió egy HTTP-fejlécben lesz átadva.

Query

string

Az API-verzió egy lekérdezési paraméterben lesz átadva.

Segment

string

Az API-verzió egy elérésiút-szegmensben lesz átadva.

WsdlSelector

A WSDL importálásának a dokumentum egy részhalmazára való korlátozására vonatkozó feltételek.

Name Típus Description
wsdlEndpointName

string

A WSDL-ből importálandó végpont(port) neve

wsdlServiceName

string

A WSDL-ből importálandó szolgáltatás neve