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

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, workspaceName, apiName, versionName, definitionName		Returns details of the API definition.
list	select	subscriptionId, resourceGroupName, serviceName, workspaceName, apiName, versionName	$filter	Returns a collection of API definitions.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, workspaceName, apiName, versionName, definitionName		Creates new or updates existing API definition.
delete	delete	subscriptionId, resourceGroupName, serviceName, workspaceName, apiName, versionName, definitionName		Deletes specified API definition.
export_specification	exec	subscriptionId, resourceGroupName, serviceName, workspaceName, apiName, versionName, definitionName		Exports the API specification.
import_specification	exec	subscriptionId, resourceGroupName, serviceName, workspaceName, apiName, versionName, definitionName		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
apiName	string	The name of the API.
definitionName	string	The name of the API definition.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of Azure API Center service.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
versionName	string	The name of the API version.
workspaceName	string	The name of the workspace.
$filter	string	OData filter parameter.

SELECT examples

get

Returns details of the API definition.

SELECT
properties
FROM azure.api_center.api_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND apiName = '{{ apiName }}' -- required
AND versionName = '{{ versionName }}' -- required
AND definitionName = '{{ definitionName }}' -- required
;

list

Returns a collection of API definitions.

SELECT
properties
FROM azure.api_center.api_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND apiName = '{{ apiName }}' -- required
AND versionName = '{{ versionName }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates new or updates existing API definition.

INSERT INTO azure.api_center.api_definitions (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
workspaceName,
apiName,
versionName,
definitionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceName }}',
'{{ apiName }}',
'{{ versionName }}',
'{{ definitionName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: api_definitions
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the api_definitions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_definitions resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_definitions resource.
    - name: workspaceName
      value: string
      description: Required parameter for the api_definitions resource.
    - name: apiName
      value: string
      description: Required parameter for the api_definitions resource.
    - name: versionName
      value: string
      description: Required parameter for the api_definitions resource.
    - name: definitionName
      value: string
      description: Required parameter for the api_definitions resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Deletes specified API definition.

DELETE FROM azure.api_center.api_definitions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND apiName = '{{ apiName }}' --required
AND versionName = '{{ versionName }}' --required
AND definitionName = '{{ definitionName }}' --required
;

Lifecycle Methods

export_specification

Exports the API specification.

EXEC azure.api_center.api_definitions.export_specification 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@apiName='{{ apiName }}' --required, 
@versionName='{{ versionName }}' --required, 
@definitionName='{{ definitionName }}' --required
;

import_specification

Imports the API specification.

EXEC azure.api_center.api_definitions.import_specification 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@apiName='{{ apiName }}' --required, 
@versionName='{{ versionName }}' --required, 
@definitionName='{{ definitionName }}' --required 
@@json=
'{
"value": "{{ value }}", 
"format": "{{ format }}", 
"specification": "{{ specification }}"
}'
;