api_definitions

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

Overview

Name	api_definitions
Type	Resource
Id	azure.api_center.api_definitions

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.
description	string	API definition description.
specification	object	API specification details.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	API definition 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.
description	string	API definition description.
specification	object	API specification details.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	API definition 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, version_name, definition_name, subscription_id		Returns details of the API definition.
list	select	resource_group_name, service_name, workspace_name, api_name, version_name, subscription_id	$filter	Returns a collection of API definitions.
create_or_update	insert	resource_group_name, service_name, workspace_name, api_name, version_name, definition_name, subscription_id		Creates new or updates existing API definition.
create_or_update	replace	resource_group_name, service_name, workspace_name, api_name, version_name, definition_name, subscription_id		Creates new or updates existing API definition.
delete	delete	resource_group_name, service_name, workspace_name, api_name, version_name, definition_name, subscription_id		Deletes specified API definition.
head	exec	resource_group_name, service_name, workspace_name, api_name, version_name, definition_name, subscription_id		Checks if specified API definition exists.
export_specification	exec	resource_group_name, service_name, workspace_name, api_name, version_name, definition_name, subscription_id		Exports the API specification.
import_specification	exec	resource_group_name, service_name, workspace_name, api_name, version_name, definition_name, subscription_id		Imports the API specification.

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.
definition_name	string	The name of the API definition. 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
version_name	string	The name of the API version. Required.
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 definition.

SELECT
id,
name,
description,
specification,
systemData,
title,
type
FROM azure.api_center.api_definitions
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 version_name = '{{ version_name }}' -- required
AND definition_name = '{{ definition_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a collection of API definitions.

SELECT
id,
name,
description,
specification,
systemData,
title,
type
FROM azure.api_center.api_definitions
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 version_name = '{{ version_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates new or updates existing API definition.

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

Manifest

# Description fields are for documentation purposes
- name: api_definitions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_definitions resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the api_definitions resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the api_definitions resource.
  - name: api_name
    value: "{{ api_name }}"
    description: Required parameter for the api_definitions resource.
  - name: version_name
    value: "{{ version_name }}"
    description: Required parameter for the api_definitions resource.
  - name: definition_name
    value: "{{ definition_name }}"
    description: Required parameter for the api_definitions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_definitions resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      title: "{{ title }}"
      description: "{{ description }}"
      specification:
        name: "{{ name }}"
        version: "{{ version }}"

REPLACE examples

create_or_update

Creates new or updates existing API definition.

REPLACE azure.api_center.api_definitions
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 version_name = '{{ version_name }}' --required
AND definition_name = '{{ definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes specified API definition.

DELETE FROM azure.api_center.api_definitions
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 version_name = '{{ version_name }}' --required
AND definition_name = '{{ definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

head

Checks if specified API definition exists.

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

export_specification

Exports the API specification.

EXEC azure.api_center.api_definitions.export_specification 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@api_name='{{ api_name }}' --required, 
@version_name='{{ version_name }}' --required, 
@definition_name='{{ definition_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

import_specification

Imports the API specification.

EXEC azure.api_center.api_definitions.import_specification 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@api_name='{{ api_name }}' --required, 
@version_name='{{ version_name }}' --required, 
@definition_name='{{ definition_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"value": "{{ value }}", 
"format": "{{ format }}", 
"specification": "{{ specification }}"
}'
;