apis

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

Overview

Name	apis
Type	Resource
Id	azure.api_center.apis

Fields

vw_apis

Name	Datatype	Description
description	text	field from the properties object
apiName	text	field from the properties object
contacts	text	field from the properties object
custom_properties	text	field from the properties object
external_documentation	text	field from the properties object
kind	text	field from the properties object
license	text	field from the properties object
lifecycle_stage	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
summary	text	field from the properties object
terms_of_service	text	field from the properties object
title	text	field from the properties object
workspaceName	text	field from the properties object

apis

Name	Datatype	Description
properties	object	API properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiName, resourceGroupName, serviceName, subscriptionId, workspaceName	Returns details of the API.
list	SELECT	resourceGroupName, serviceName, subscriptionId, workspaceName	Returns a collection of APIs.
create_or_update	INSERT	apiName, resourceGroupName, serviceName, subscriptionId, workspaceName	Creates new or updates existing API.
delete	DELETE	apiName, resourceGroupName, serviceName, subscriptionId, workspaceName	Deletes specified API.

SELECT examples

Returns a collection of APIs.

vw_apis

SELECT
description,
apiName,
contacts,
custom_properties,
external_documentation,
kind,
license,
lifecycle_stage,
resourceGroupName,
serviceName,
subscriptionId,
summary,
terms_of_service,
title,
workspaceName
FROM azure.api_center.vw_apis
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

apis

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: title
          value: string
        - name: kind
          value: []
        - name: description
          value: string
        - name: summary
          value: string
        - name: lifecycleStage
          value: []
        - name: termsOfService
          value:
            - name: url
              value: string
        - name: externalDocumentation
          value:
            - - name: title
                value: string
              - name: description
                value: string
              - name: url
                value: string
        - name: contacts
          value:
            - - name: name
                value: string
              - name: url
                value: string
              - name: email
                value: string
        - name: license
          value:
            - name: name
              value: string
            - name: url
              value: string
            - name: identifier
              value: string
        - name: customProperties
          value: []

DELETE example

Deletes the specified apis resource.

/*+ delete */
DELETE FROM azure.api_center.apis
WHERE apiName = '{{ apiName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';