apis

Creates, updates, deletes, gets or lists a apis resource.

Overview

Name	apis
Type	Resource
Id	azure.api_management.apis

Fields

vw_apis

Name	Datatype	Description
description	text	field from the properties object
apiId	text	field from the properties object
api_revision	text	field from the properties object
api_revision_description	text	field from the properties object
api_version	text	field from the properties object
api_version_description	text	field from the properties object
api_version_set	text	field from the properties object
api_version_set_id	text	field from the properties object
authentication_settings	text	field from the properties object
contact	text	field from the properties object
display_name	text	field from the properties object
is_current	text	field from the properties object
is_online	text	field from the properties object
license	text	field from the properties object
path	text	field from the properties object
protocols	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
service_url	text	field from the properties object
source_api_id	text	field from the properties object
subscriptionId	text	field from the properties object
subscription_key_parameter_names	text	field from the properties object
subscription_required	text	field from the properties object
terms_of_service_url	text	field from the properties object
type	text	field from the properties object

apis

Name	Datatype	Description
properties	object	API Entity Properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiId, resourceGroupName, serviceName, subscriptionId	Gets the details of the API specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists all APIs of the API Management service instance.
list_by_tags	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of apis associated with tags.
create_or_update	INSERT	apiId, resourceGroupName, serviceName, subscriptionId	Creates new or updates existing specified API of the API Management service instance.
delete	DELETE	If-Match, apiId, resourceGroupName, serviceName, subscriptionId	Deletes the specified API of the API Management service instance.
update	UPDATE	If-Match, apiId, resourceGroupName, serviceName, subscriptionId	Updates the specified API of the API Management service instance.

SELECT examples

Lists all APIs of the API Management service instance.

vw_apis

SELECT
description,
apiId,
api_revision,
api_revision_description,
api_version,
api_version_description,
api_version_set,
api_version_set_id,
authentication_settings,
contact,
display_name,
is_current,
is_online,
license,
path,
protocols,
provisioning_state,
resourceGroupName,
serviceName,
service_url,
source_api_id,
subscriptionId,
subscription_key_parameter_names,
subscription_required,
terms_of_service_url,
type
FROM azure.api_management.vw_apis
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

apis

SELECT
properties
FROM azure.api_management.apis
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new apis resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.apis (
apiId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ apiId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: value
          value: string
        - name: format
          value: string
        - name: wsdlSelector
          value:
            - name: wsdlServiceName
              value: string
            - name: wsdlEndpointName
              value: string
        - name: apiType
          value: string
        - name: translateRequiredQueryParameters
          value: string
        - name: sourceApiId
          value: string
        - name: displayName
          value: string
        - name: serviceUrl
          value: string
        - name: path
          value: string
        - name: protocols
          value:
            - string
        - name: apiVersionSet
          value:
            - name: id
              value: string
            - name: name
              value: string
            - name: description
              value: string
            - name: versioningScheme
              value: string
            - name: versionQueryName
              value: string
            - name: versionHeaderName
              value: string
        - name: provisioningState
          value: string

UPDATE example

Updates a apis resource.

/*+ update */
UPDATE azure.api_management.apis
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified apis resource.

/*+ delete */
DELETE FROM azure.api_management.apis
WHERE If-Match = '{{ If-Match }}'
AND apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';