apis

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

Overview

Name	apis
Type	Resource
Id	azure.api_center.apis

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
contacts	array	The set of contacts.
customProperties	object	The custom metadata defined for API catalog entities.
description	string	Description of the API.
externalDocumentation	array	The set of external documentation.
kind	string	Kind of API. For example, REST or GraphQL. Required. Known values are: "rest", "graphql", "grpc", "soap", "webhook", and "websocket".
license	object	The license information for the API.
lifecycleStage	string	Current lifecycle stage of the API. Known values are: "design", "development", "testing", "preview", "production", "deprecated", and "retired".
summary	string	Short description of the API.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
termsOfService	object	Terms of service for the API.
title	string	API title. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
contacts	array	The set of contacts.
customProperties	object	The custom metadata defined for API catalog entities.
description	string	Description of the API.
externalDocumentation	array	The set of external documentation.
kind	string	Kind of API. For example, REST or GraphQL. Required. Known values are: "rest", "graphql", "grpc", "soap", "webhook", and "websocket".
license	object	The license information for the API.
lifecycleStage	string	Current lifecycle stage of the API. Known values are: "design", "development", "testing", "preview", "production", "deprecated", and "retired".
summary	string	Short description of the API.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
termsOfService	object	Terms of service for the API.
title	string	API title. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, workspace_name, api_name, subscription_id		Returns details of the API.
list	select	resource_group_name, service_name, workspace_name, subscription_id	$filter	Returns a collection of APIs.
create_or_update	insert	resource_group_name, service_name, workspace_name, api_name, subscription_id		Creates new or updates existing API.
create_or_update	replace	resource_group_name, service_name, workspace_name, api_name, subscription_id		Creates new or updates existing API.
delete	delete	resource_group_name, service_name, workspace_name, api_name, subscription_id		Deletes specified API.
head	exec	resource_group_name, service_name, workspace_name, api_name, subscription_id		Checks if specified API exists.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_name	string	The name of the API. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of Azure API Center service. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.
$filter	string	OData filter parameter. Default value is None.

SELECT examples

get

Returns details of the API.

SELECT
id,
name,
contacts,
customProperties,
description,
externalDocumentation,
kind,
license,
lifecycleStage,
summary,
systemData,
termsOfService,
title,
type
FROM azure.api_center.apis
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND api_name = '{{ api_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a collection of APIs.

SELECT
id,
name,
contacts,
customProperties,
description,
externalDocumentation,
kind,
license,
lifecycleStage,
summary,
systemData,
termsOfService,
title,
type
FROM azure.api_center.apis
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates new or updates existing API.

INSERT INTO azure.api_center.apis (
properties,
resource_group_name,
service_name,
workspace_name,
api_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_name }}',
'{{ api_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: apis
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the apis resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the apis resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the apis resource.
  - name: api_name
    value: "{{ api_name }}"
    description: Required parameter for the apis resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the apis resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      title: "{{ title }}"
      kind: "{{ kind }}"
      description: "{{ description }}"
      summary: "{{ summary }}"
      lifecycleStage: "{{ lifecycleStage }}"
      termsOfService:
        url: "{{ url }}"
      externalDocumentation:
        - title: "{{ title }}"
          description: "{{ description }}"
          url: "{{ url }}"
      contacts:
        - name: "{{ name }}"
          url: "{{ url }}"
          email: "{{ email }}"
      license:
        name: "{{ name }}"
        url: "{{ url }}"
        identifier: "{{ identifier }}"
      customProperties: "{{ customProperties }}"

REPLACE examples

create_or_update

Creates new or updates existing API.

REPLACE azure.api_center.apis
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND api_name = '{{ api_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes specified API.

DELETE FROM azure.api_center.apis
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND api_name = '{{ api_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

head

Checks if specified API exists.

EXEC azure.api_center.apis.head 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@api_name='{{ api_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;