Apis - Get

Reference

Service:: API Management

API Version:: 2024-05-01

Gets the details of the API specified by its identifier.

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

URI Parameters

Name	In	Required	Type	Description
apiId	path	True	string	API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. Regex pattern: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ApiContract	The response body contains the specified API entity. Headers ETag: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Name

Type

Description

200 OK

ApiContract

The response body contains the specified API entity.

Headers

ETag: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementGetApiContract

ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "displayName": "Service",
    "apiRevision": "1",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementGetApiRevisionContract

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Service",
    "apiRevision": "3",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

Definitions

Name	Description
ApiContactInformation	API contact information
ApiContract	API details.
ApiLicenseInformation	API license information
ApiType	Type of API.
ApiVersionSetContractDetails	An API Version Set contains the common configuration for a set of API Versions relating
AuthenticationSettingsContract	API Authentication Settings.
bearerTokenSendingMethods	How to send token to the server.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
OAuth2AuthenticationSettingsContract	API OAuth2 Authentication settings details.
OpenIdAuthenticationSettingsContract	API OAuth2 Authentication settings details.
Protocol	Describes on which protocols the operations in this API can be invoked.
SubscriptionKeyParameterNamesContract	Subscription key parameter names details.
versioningScheme	An value that determines where the API Version identifier will be located in a HTTP request.

ApiContactInformation

API contact information

Name	Type	Description
email	string	The email address of the contact person/organization. MUST be in the format of an email address
name	string	The identifying name of the contact person/organization
url	string	The URL pointing to the contact information. MUST be in the format of a URL

ApiContract

API details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.apiRevision	string	Describes the revision of the API. If no value is provided, default revision 1 is created
properties.apiRevisionDescription	string	Description of the API Revision.
properties.apiVersion	string	Indicates the version identifier of the API if the API is versioned
properties.apiVersionDescription	string	Description of the API Version.
properties.apiVersionSet	ApiVersionSetContractDetails	Version set details
properties.apiVersionSetId	string	A resource identifier for the related ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Collection of authentication settings included into this API.
properties.contact	ApiContactInformation	Contact information for the API.
properties.description	string	Description of the API. May include HTML formatting tags.
properties.displayName	string	API name. Must be 1 to 300 characters long.
properties.isCurrent	boolean	Indicates if API revision is current api revision.
properties.isOnline	boolean	Indicates if API revision is accessible via the gateway.
properties.license	ApiLicenseInformation	License information for the API.
properties.path	string	Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
properties.protocols	Protocol[]	Describes on which protocols the operations in this API can be invoked.
properties.provisioningState	string	The provisioning state
properties.serviceUrl	string	Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
properties.sourceApiId	string	API identifier of the source API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocols over which API is made available.
properties.subscriptionRequired	boolean	Specifies whether an API or Product subscription is required for accessing the API.
properties.termsOfServiceUrl	string	A URL to the Terms of Service for the API. MUST be in the format of a URL.
properties.type	ApiType	Type of API.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

API license information

Name	Type	Description
name	string	The license name used for the API
url	string	A URL to the license used for the API. MUST be in the format of a URL

ApiType

Type of API.

Name	Type	Description
graphql	string
grpc	string
http	string
odata	string
soap	string
websocket	string

ApiVersionSetContractDetails

An API Version Set contains the common configuration for a set of API Versions relating

Name	Type	Description
description	string	Description of API Version Set.
id	string	Identifier for existing API Version Set. Omit this value to create a new Version Set.
name	string	The display Name of the API Version Set.
versionHeaderName	string	Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
versionQueryName	string	Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
versioningScheme	versioningScheme	An value that determines where the API Version identifier will be located in a HTTP request.

AuthenticationSettingsContract

API Authentication Settings.

Name	Type	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 Authentication settings
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Collection of OAuth2 authentication settings included into this API.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect Authentication Settings
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Collection of Open ID Connect authentication settings included into this API.

bearerTokenSendingMethods

How to send token to the server.

Name	Type	Description
authorizationHeader	string	Access token will be transmitted in the Authorization header using Bearer schema
query	string	Access token will be transmitted as query parameters.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

OAuth2AuthenticationSettingsContract

API OAuth2 Authentication settings details.

Name	Type	Description
authorizationServerId	string	OAuth authorization server identifier.
scope	string	operations scope.

OpenIdAuthenticationSettingsContract

API OAuth2 Authentication settings details.

Name	Type	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	How to send token to the server.
openidProviderId	string	OAuth authorization server identifier.

Protocol

Describes on which protocols the operations in this API can be invoked.

Name	Type	Description
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

Subscription key parameter names details.

Name	Type	Description
header	string	Subscription key header name.
query	string	Subscription key query string parameter name.

versioningScheme

An value that determines where the API Version identifier will be located in a HTTP request.

Name	Type	Description
Header	string	The API Version is passed in a HTTP header.
Query	string	The API Version is passed in a query parameter.
Segment	string	The API Version is passed in a path segment.

共用方式為

Apis - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ApiManagementGetApiContract

Sample request

Sample response

ApiManagementGetApiRevisionContract

Sample request

Sample response

Definitions

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme

其他資源