workspace_apis

Creates, updates, deletes, gets or lists a workspace_apis resource.

Overview

Name	workspace_apis
Type	Resource
Id	azure.api_management.workspace_apis

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified API entity.

Name	Datatype	Description
properties	object	API entity contract properties.

list_by_service

Paged Result response of Apis.

Name	Datatype	Description
properties	object	API entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, workspaceId, apiId, subscriptionId		Gets the details of the API specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, workspaceId, subscriptionId	$filter, $top, $skip, tags, expandApiVersionSet	Lists all APIs of the workspace in an API Management service instance.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, apiId, subscriptionId	If-Match	Creates new or updates existing specified API of the workspace in an API Management service instance.
update	update	resourceGroupName, serviceName, workspaceId, apiId, If-Match, subscriptionId		Updates the specified API of the workspace in an API Management service instance.
delete	delete	resourceGroupName, serviceName, workspaceId, apiId, If-Match, subscriptionId	deleteRevisions	Deletes the specified API of the workspace in an API Management service instance.

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.
apiId	string	API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
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.
workspaceId	string	Workspace identifier. Must be unique in the current API Management service instance.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| isCurrent | filter | eq, ne | |</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.
deleteRevisions	boolean	Delete all revisions of the Api.
expandApiVersionSet	boolean	Include full ApiVersionSet resource in response
tags	string	Include tags in the response.

SELECT examples

get

Gets the details of the API specified by its identifier.

SELECT
properties
FROM azure.api_management.workspace_apis
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND apiId = '{{ apiId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

Lists all APIs of the workspace in an API Management service instance.

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

INSERT examples

create_or_update

Creates new or updates existing specified API of the workspace in an API Management service instance.

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

Manifest

# Description fields are for documentation purposes
- name: workspace_apis
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_apis resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_apis resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_apis resource.
    - name: apiId
      value: string
      description: Required parameter for the workspace_apis resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_apis resource.
    - name: properties
      value: object
      description: |
        API entity create of update 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 specified API of the workspace in an API Management service instance.

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

DELETE examples

delete

Deletes the specified API of the workspace in an API Management service instance.

DELETE FROM azure.api_management.workspace_apis
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND workspaceId = '{{ workspaceId }}' --required
AND apiId = '{{ apiId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND deleteRevisions = '{{ deleteRevisions }}'
;