Apis - Create Or Update

  • Reference
Service:
API Management
API Version:
2022-08-01

Vytvoří nové nebo aktualizuje existující zadané rozhraní API instance služby API Management.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
apiId
 path True

string

Identifikátor revize rozhraní API. Musí být jedinečný v aktuální instanci služby API Management. Non-current revize má ; rev=n jako přípona, kde n je číslo revize.

Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName
 path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName
 path True

string

Název služby API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ID cílového předplatného.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description
If-Match

string

Značka ETag entity. Nevyžaduje se při vytváření entity, ale vyžaduje se při aktualizaci entity.

Text požadavku

Name Vyžadováno Typ Description
properties.path True

string

Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadanou při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
apiRevision

string

Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.
apiRevisionDescription

string

Popis revize rozhraní API
apiVersion

string

Označuje identifikátor verze rozhraní API, pokud je rozhraní API ve verzi.
apiVersionDescription

string

Popis verze rozhraní API
apiVersionSetId

string

Identifikátor prostředku pro související apiVersionSet.
authenticationSettings

AuthenticationSettingsContract

Kolekce nastavení ověřování zahrnutých v tomto rozhraní API
contact

ApiContactInformation

Kontaktní informace pro rozhraní API
description

string

Popis rozhraní API Může obsahovat značky formátování HTML.
isCurrent

boolean

Označuje, jestli je revize rozhraní API aktuální revize rozhraní API.
license

ApiLicenseInformation

Informace o licencích pro rozhraní API
properties.apiType

SoapApiType

Typ rozhraní API, které chcete vytvořit.

  • http vytvoří rozhraní REST API.
  • soap vytvoří předávací rozhraní API protokolu SOAP.
  • websocket vytvoří rozhraní WEBSocket API.
  • graphql vytvoří rozhraní GraphQL API.
properties.apiVersionSet

ApiVersionSetContractDetails

Podrobnosti o sadě verzí
properties.displayName

string

Název rozhraní API. Musí mít délku 1 až 300 znaků.
properties.format

ContentFormat

Formát obsahu, ve kterém se rozhraní API importuje.
properties.protocols

Protocol[]

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
properties.serviceUrl

string

Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2000 znaků.
properties.sourceApiId

string

Identifikátor rozhraní API zdrojového rozhraní API
properties.translateRequiredQueryParameters

TranslateRequiredQueryParametersConduct

Strategie překladu požadovaných parametrů dotazu na parametry šablony. Ve výchozím nastavení má hodnotu "šablona". Možné hodnoty: 'template', 'query'
properties.value

string

Hodnota obsahu při importu rozhraní API
properties.wsdlSelector

WsdlSelector

Kritéria pro omezení importu WSDL na podmnožinu dokumentu
subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokoly, přes které je k dispozici rozhraní API.
subscriptionRequired

boolean

Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo product.
termsOfServiceUrl

string

Adresa URL pro podmínky služby pro rozhraní API. MUSÍ být ve formátu adresy URL.
type

ApiType

Typ rozhraní API

Odpovědi

Name Typ Description
200 OK

ApiContract

Rozhraní API se úspěšně aktualizovalo.

Headers

ETag: string
201 Created

ApiContract

Rozhraní API se úspěšně vytvořilo.

Headers

ETag: string
202 Accepted

Žádost o vytvoření nebo aktualizaci rozhraní API byla přijata. Hlavička umístění obsahuje adresu URL, kde je možné zkontrolovat stav dlouhotrvající operace.
Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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

ApiManagementCreateApi

Sample Request

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"
    ]
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
  }
}

Sample Response

Status code:
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"
    }
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
  }
}

Sample Response

Status code:
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"
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
    ]
  }
}

Sample Response

Status code:
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"
    ],
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "isCurrent": true,
    "isOnline": true
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
    ]
  }
}

Sample Response

Status code:
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"
    ],
    "subscriptionKeyParameterNames": {
      "header": "header4520",
      "query": "query3037"
    },
    "isCurrent": true,
    "isOnline": true
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
    }
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
    ]
  }
}

Sample Response

Status code:
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": [
      "https",
      "https"
    ],
    "authenticationSettings": null,
    "subscriptionKeyParameterNames": null,
    "isCurrent": true,
    "isOnline": true
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
    }
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
    }
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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

Sample Request

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"
    ]
  }
}

Sample Response

Status code:
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
  }
}
Status code:
202 
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
Status code:
200 
{
  "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
  }
}

Definice

Name Description
ApiContactInformation

Kontaktní informace rozhraní API
ApiContract

Podrobnosti rozhraní API
ApiCreateOrUpdateParameter

Parametry pro vytvoření nebo aktualizaci rozhraní API
ApiLicenseInformation

Informace o licencích rozhraní API
ApiType

Typ rozhraní API
ApiVersionSetContractDetails

Sada verzí rozhraní API obsahuje běžnou konfiguraci pro sadu verzí rozhraní API, které se týkají.
AuthenticationSettingsContract

Nastavení ověřování rozhraní API.
bearerTokenSendingMethods

Postup odeslání tokenu na server
ContentFormat

Formát obsahu, ve kterém se rozhraní API importuje.
ErrorFieldContract

Chyba Kontrakt pole.
ErrorResponse

Odpověď na chybu.
OAuth2AuthenticationSettingsContract

Podrobnosti o nastavení ověřování api OAuth2
OpenIdAuthenticationSettingsContract

Podrobnosti o nastavení ověřování api OAuth2
Protocol

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
SoapApiType

Typ rozhraní API, které chcete vytvořit.

  • http vytvoří rozhraní REST API.
  • soap vytvoří předávací rozhraní API protokolu SOAP.
  • websocket vytvoří rozhraní WEBSocket API.
  • graphql vytvoří rozhraní GraphQL API.
SubscriptionKeyParameterNamesContract

Podrobnosti o názvech parametrů klíče předplatného
TranslateRequiredQueryParametersConduct

Strategie překladu požadovaných parametrů dotazu na parametry šablony. Ve výchozím nastavení má hodnotu "šablona". Možné hodnoty: 'template', 'query'
versioningScheme

Hodnota, která určuje, kde se bude v požadavku HTTP nacházet identifikátor verze rozhraní API.
WsdlSelector

Kritéria pro omezení importu WSDL na podmnožinu dokumentu

ApiContactInformation

Kontaktní informace rozhraní API

Name Typ Description
email

string

E-mailová adresa kontaktní osoby nebo organizace MUSÍ být ve formátu e-mailové adresy.
name

string

Identifikační jméno kontaktní osoby nebo organizace
url

string

Adresa URL odkazující na kontaktní informace. MUSÍ být ve formátu adresy URL.

ApiContract

Podrobnosti rozhraní API

Name Typ Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name

string

Název prostředku
properties.apiRevision

string

Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1.
properties.apiRevisionDescription

string

Popis revize rozhraní API
properties.apiVersion

string

Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.
properties.apiVersionDescription

string

Popis verze rozhraní API.
properties.apiVersionSet

ApiVersionSetContractDetails

Podrobnosti sady verzí
properties.apiVersionSetId

string

Identifikátor prostředku pro související ApiVersionSet.
properties.authenticationSettings

AuthenticationSettingsContract

Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API
properties.contact

ApiContactInformation

Kontaktní informace pro rozhraní API.
properties.description

string

Popis rozhraní API. Mohou obsahovat značky formátování HTML.
properties.displayName

string

Název rozhraní API. Musí mít délku 1 až 300 znaků.
properties.isCurrent

boolean

Označuje, jestli je revize rozhraní API aktuální revize rozhraní API.
properties.isOnline

boolean

Označuje, jestli je revize rozhraní API přístupná prostřednictvím brány.
properties.license

ApiLicenseInformation

Informace o licenci pro rozhraní API
properties.path

string

Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v instanci služby API Management Připojí se k základní adrese URL koncového bodu rozhraní API zadané při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
properties.protocols

Protocol[]

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
properties.serviceUrl

string

Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2 000 znaků.
properties.sourceApiId

string

Identifikátor rozhraní API zdrojového rozhraní API
properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokoly, přes které je k dispozici rozhraní API.
properties.subscriptionRequired

boolean

Určuje, jestli se pro přístup k rozhraní API vyžaduje rozhraní API nebo předplatné produktu.
properties.termsOfServiceUrl

string

Adresa URL podmínek služby pro rozhraní API. MUSÍ být ve formátu adresy URL.
properties.type

ApiType

Typ rozhraní API
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ApiCreateOrUpdateParameter

Parametry pro vytvoření nebo aktualizaci rozhraní API

Name Typ Description
apiRevision

string

Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1.
apiRevisionDescription

string

Popis revize rozhraní API
apiVersion

string

Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.
apiVersionDescription

string

Popis verze rozhraní API
apiVersionSetId

string

Identifikátor prostředku pro související apiVersionSet.
authenticationSettings

AuthenticationSettingsContract

Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API
contact

ApiContactInformation

Kontaktní informace pro rozhraní API
description

string

Popis rozhraní API. Mohou obsahovat značky formátování HTML.
isCurrent

boolean

Označuje, jestli je revize rozhraní API aktuální revize rozhraní API.
isOnline

boolean

Označuje, jestli je revize rozhraní API přístupná prostřednictvím brány.
license

ApiLicenseInformation

Informace o licencích pro rozhraní API
properties.apiType

SoapApiType

Typ rozhraní API, které chcete vytvořit.

  • http vytvoří rozhraní REST API.
  • soap vytvoří předávací rozhraní API protokolu SOAP.
  • websocket vytvoří rozhraní WEBSocket API.
  • graphql vytvoří rozhraní GraphQL API.
properties.apiVersionSet

ApiVersionSetContractDetails

Podrobnosti sady verzí
properties.displayName

string

Název rozhraní API. Musí mít délku 1 až 300 znaků.
properties.format

ContentFormat

Formát obsahu, ve kterém se rozhraní API importuje.
properties.path

string

Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v instanci služby API Management Připojí se k základní adrese URL koncového bodu rozhraní API zadané při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
properties.protocols

Protocol[]

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
properties.serviceUrl

string

Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2 000 znaků.
properties.sourceApiId

string

Identifikátor rozhraní API zdrojového rozhraní API
properties.translateRequiredQueryParameters

TranslateRequiredQueryParametersConduct

Strategie převodu požadovaných parametrů dotazu na parametry šablony Ve výchozím nastavení má hodnotu "template". Možné hodnoty: template, query
properties.value

string

Hodnota obsahu při importu rozhraní API
properties.wsdlSelector

WsdlSelector

Kritéria pro omezení importu WSDL na podmnožinu dokumentu
subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokoly, přes které je k dispozici rozhraní API.
subscriptionRequired

boolean

Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo product.
termsOfServiceUrl

string

Adresa URL pro podmínky služby pro rozhraní API. MUSÍ být ve formátu adresy URL.
type

ApiType

Typ rozhraní API

ApiLicenseInformation

Informace o licencích rozhraní API

Name Typ Description
name

string

Název licence použitý pro rozhraní API
url

string

Adresa URL licence použité pro rozhraní API. MUSÍ být ve formátu adresy URL.

ApiType

Typ rozhraní API

Name Typ Description
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

Sada verzí rozhraní API obsahuje běžnou konfiguraci pro sadu verzí rozhraní API, které se týkají.

Name Typ Description
description

string

Popis sady verzí rozhraní API.
id

string

Identifikátor existující sady verzí rozhraní API Pokud chcete vytvořit novou sadu verzí, tuto hodnotu vynecháte.
name

string

Zobrazovaný název sady verzí rozhraní API.
versionHeaderName

string

Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na headerhodnotu .
versionQueryName

string

Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzíScheme nastavená na query.
versioningScheme

versioningScheme

Hodnota, která určuje, kde se v požadavku HTTP bude nacházet identifikátor verze rozhraní API.

AuthenticationSettingsContract

Nastavení ověřování rozhraní API.

Name Typ Description
oAuth2

OAuth2AuthenticationSettingsContract

Nastavení ověřování OAuth2
oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API.
openid

OpenIdAuthenticationSettingsContract

Nastavení ověřování OpenID Connect
openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API.

bearerTokenSendingMethods

Postup odeslání tokenu na server

Name Typ Description
authorizationHeader

string

Přístupový token se bude přenášet v autorizační hlavičce pomocí nosného schématu.
query

string

Přístupový token se bude přenášet jako parametry dotazu.

ContentFormat

Formát obsahu, ve kterém se rozhraní API importuje.

Name Typ Description
graphql-link

string

Koncový bod rozhraní GraphQL API hostovaný na veřejně přístupné internetové adrese.
openapi

string

Obsah je vložený a typ obsahu je dokument YAML openAPI 3.0.
openapi+json

string

Obsah je vložený a typ obsahu je dokument JSON OpenAPI 3.0.
openapi+json-link

string

Dokument JSON OpenAPI 3.0 je hostovaný na veřejně přístupné internetové adrese.
openapi-link

string

Dokument OpenAPI 3.0 YAML je hostovaný na veřejně přístupné internetové adrese.
swagger-json

string

Obsah je vložený a typ obsahu je dokument JSON OpenAPI 2.0.
swagger-link-json

string

Dokument JSON OpenAPI 2.0 je hostovaný na veřejně přístupné internetové adrese.
wadl-link-json

string

Dokument WADL je hostovaný na veřejně přístupné internetové adrese.
wadl-xml

string

Obsah je vložený a Typ obsahu je dokument WADL.
wsdl

string

Obsah je vložený a dokument je dokument WSDL/Soap.
wsdl-link

string

Dokument WSDL je hostovaný na veřejně přístupné internetové adrese.

ErrorFieldContract

Chyba Kontrakt pole.

Name Typ Description
code

string

Kód chyby na úrovni vlastnosti.
message

string

Čitelné znázornění chyby na úrovni vlastností.
target

string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
error.code

string

Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details

ErrorFieldContract[]

Seznam neplatných polí se odešle v požadavku v případě chyby ověření.
error.message

string

Pro člověka čitelná reprezentace chyby.

OAuth2AuthenticationSettingsContract

Podrobnosti o nastavení ověřování api OAuth2

Name Typ Description
authorizationServerId

string

Identifikátor autorizačního serveru OAuth.
scope

string

rozsah operací.

OpenIdAuthenticationSettingsContract

Podrobnosti o nastavení ověřování api OAuth2

Name Typ Description
bearerTokenSendingMethods

bearerTokenSendingMethods[]

Postup odeslání tokenu na server
openidProviderId

string

Identifikátor autorizačního serveru OAuth.

Protocol

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.

Name Typ Description
http

string

https

string

ws

string

wss

string

SoapApiType

Typ rozhraní API, které chcete vytvořit.

  • http vytvoří rozhraní REST API.
  • soap vytvoří předávací rozhraní API protokolu SOAP.
  • websocket vytvoří rozhraní WEBSocket API.
  • graphql vytvoří rozhraní GraphQL API.
Name Typ Description
graphql

string

Importuje rozhraní API s front-endem GraphQL.
http

string

Importuje rozhraní SOAP API s front-endem RESTful.
soap

string

Importuje rozhraní SOAP API s front-endem SOAP.
websocket

string

Importuje rozhraní API s front-endem websocket.

SubscriptionKeyParameterNamesContract

Podrobnosti o názvech parametrů klíče předplatného

Name Typ Description
header

string

Název hlavičky klíče předplatného.
query

string

Název parametru řetězce dotazu klíče předplatného.

TranslateRequiredQueryParametersConduct

Strategie překladu požadovaných parametrů dotazu na parametry šablony. Ve výchozím nastavení má hodnotu "šablona". Možné hodnoty: 'template', 'query'

Name Typ Description
query

string

Požadované parametry dotazu ponechá tak, jak jsou (bez překladu).
template

string

Přeloží požadované parametry dotazu na parametry šablony. Je výchozí hodnota.

versioningScheme

Hodnota, která určuje, kde se bude v požadavku HTTP nacházet identifikátor verze rozhraní API.

Name Typ Description
Header

string

Verze rozhraní API se předává v hlavičce HTTP.
Query

string

Verze rozhraní API se předává v parametru dotazu.
Segment

string

Verze rozhraní API se předává v segmentu cesty.

WsdlSelector

Kritéria pro omezení importu WSDL na podmnožinu dokumentu

Name Typ Description
wsdlEndpointName

string

Název koncového bodu (portu) pro import z WSDL
wsdlServiceName

string

Název služby, která se má importovat z WSDL