api_version_sets

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

Overview

Name	api_version_sets
Type	Resource
Id	azure.api_management.api_version_sets

Fields

The following fields are returned by SELECT queries:

get

Gets the specified Api Version Set entity.

Name	Datatype	Description
properties	object	API VersionSet contract properties.

list_by_service

Lists a collection of Api Version Set entities.

Name	Datatype	Description
properties	object	API VersionSet contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, versionSetId, subscriptionId		Gets the details of the Api Version Set specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip	Lists a collection of API Version Sets in the specified service instance.
create_or_update	insert	resourceGroupName, serviceName, versionSetId, subscriptionId	If-Match	Creates or Updates a Api Version Set.
update	update	resourceGroupName, serviceName, versionSetId, If-Match, subscriptionId		Updates the details of the Api VersionSet specified by its identifier.
delete	delete	resourceGroupName, serviceName, versionSetId, If-Match, subscriptionId		Deletes specific Api Version Set.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
versionSetId	string	Api Version Set identifier. Must be unique in the current API Management service instance.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Gets the details of the Api Version Set specified by its identifier.

SELECT
properties
FROM azure.api_management.api_version_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND versionSetId = '{{ versionSetId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

Lists a collection of API Version Sets in the specified service instance.

SELECT
properties
FROM azure.api_management.api_version_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates or Updates a Api Version Set.

INSERT INTO azure.api_management.api_version_sets (
data__properties,
resourceGroupName,
serviceName,
versionSetId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ versionSetId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: api_version_sets
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_version_sets resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_version_sets resource.
    - name: versionSetId
      value: string
      description: Required parameter for the api_version_sets resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the api_version_sets resource.
    - name: properties
      value: object
      description: |
        API VersionSet contract properties.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

Updates the details of the Api VersionSet specified by its identifier.

UPDATE azure.api_management.api_version_sets
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND versionSetId = '{{ versionSetId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes specific Api Version Set.

DELETE FROM azure.api_management.api_version_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND versionSetId = '{{ versionSetId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;