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

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		Returns details of the API.
list	select	subscriptionId, resourceGroupName, serviceName, workspaceName	$filter	Returns a collection of APIs.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, workspaceName, apiName		Creates new or updates existing API.
delete	delete	subscriptionId, resourceGroupName, serviceName, workspaceName, apiName		Deletes specified API.

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.
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.
workspaceName	string	The name of the workspace.
$filter	string	OData filter parameter.

SELECT examples

get

Returns details of the API.

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

list

Returns a collection of APIs.

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

INSERT examples

create_or_update

Creates new or updates existing API.

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

Manifest

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

DELETE examples

delete

Deletes specified API.

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