api_versions

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

Overview

Name	api_versions
Type	Resource
Id	azure.api_center.api_versions

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

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.
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 version.

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

list

Returns a collection of API versions.

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

INSERT examples

create_or_update

Creates new or updates existing API version.

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

Manifest

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

DELETE examples

delete

Deletes specified API version

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