api_operations

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

Overview

Name	api_operations
Type	Resource
Id	azure.api_management.api_operations

Fields

vw_api_operations

Name	Datatype	Description
description	text	field from the properties object
apiId	text	field from the properties object
display_name	text	field from the properties object
method	text	field from the properties object
operationId	text	field from the properties object
policies	text	field from the properties object
request	text	field from the properties object
resourceGroupName	text	field from the properties object
responses	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
template_parameters	text	field from the properties object
url_template	text	field from the properties object

api_operations

Name	Datatype	Description
properties	object	Operation Contract Properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiId, operationId, resourceGroupName, serviceName, subscriptionId	Gets the details of the API Operation specified by its identifier.
list_by_api	SELECT	apiId, resourceGroupName, serviceName, subscriptionId	Lists a collection of the operations for the specified API.
create_or_update	INSERT	apiId, operationId, resourceGroupName, serviceName, subscriptionId	Creates a new operation in the API or updates an existing one.
delete	DELETE	If-Match, apiId, operationId, resourceGroupName, serviceName, subscriptionId	Deletes the specified operation in the API.
update	UPDATE	If-Match, apiId, operationId, resourceGroupName, serviceName, subscriptionId	Updates the details of the operation in the API specified by its identifier.

SELECT examples

Lists a collection of the operations for the specified API.

vw_api_operations

SELECT
description,
apiId,
display_name,
method,
operationId,
policies,
request,
resourceGroupName,
responses,
serviceName,
subscriptionId,
template_parameters,
url_template
FROM azure.api_management.vw_api_operations
WHERE apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

api_operations

SELECT
properties
FROM azure.api_management.api_operations
WHERE apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new api_operations resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.api_operations (
apiId,
operationId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ apiId }}',
'{{ operationId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: displayName
          value: string
        - name: method
          value: string
        - name: urlTemplate
          value: string
        - name: templateParameters
          value:
            - - name: name
                value: string
              - name: description
                value: string
              - name: type
                value: string
              - name: defaultValue
                value: string
              - name: required
                value: boolean
              - name: values
                value:
                  - string
              - name: schemaId
                value: string
              - name: typeName
                value: string
              - name: examples
                value: []
        - name: description
          value: string
        - name: request
          value:
            - name: description
              value: string
            - name: queryParameters
              value:
                - - name: name
                    value: string
                  - name: description
                    value: string
                  - name: type
                    value: string
                  - name: defaultValue
                    value: string
                  - name: required
                    value: boolean
                  - name: values
                    value:
                      - string
                  - name: schemaId
                    value: string
                  - name: typeName
                    value: string
            - name: headers
              value:
                - - name: name
                    value: string
                  - name: description
                    value: string
                  - name: type
                    value: string
                  - name: defaultValue
                    value: string
                  - name: required
                    value: boolean
                  - name: values
                    value:
                      - string
                  - name: schemaId
                    value: string
                  - name: typeName
                    value: string
            - name: representations
              value:
                - - name: contentType
                    value: string
                  - name: schemaId
                    value: string
                  - name: typeName
                    value: string
                  - name: formParameters
                    value:
                      - - name: name
                          value: string
                        - name: description
                          value: string
                        - name: type
                          value: string
                        - name: defaultValue
                          value: string
                        - name: required
                          value: boolean
                        - name: values
                          value:
                            - string
                        - name: schemaId
                          value: string
                        - name: typeName
                          value: string
        - name: responses
          value:
            - - name: statusCode
                value: integer
              - name: description
                value: string
              - name: representations
                value:
                  - - name: contentType
                      value: string
                    - name: schemaId
                      value: string
                    - name: typeName
                      value: string
                    - name: formParameters
                      value:
                        - - name: name
                            value: string
                          - name: description
                            value: string
                          - name: type
                            value: string
                          - name: defaultValue
                            value: string
                          - name: required
                            value: boolean
                          - name: values
                            value:
                              - string
                          - name: schemaId
                            value: string
                          - name: typeName
                            value: string
              - name: headers
                value:
                  - - name: name
                      value: string
                    - name: description
                      value: string
                    - name: type
                      value: string
                    - name: defaultValue
                      value: string
                    - name: required
                      value: boolean
                    - name: values
                      value:
                        - string
                    - name: schemaId
                      value: string
                    - name: typeName
                      value: string
        - name: policies
          value: string

UPDATE example

Updates a api_operations resource.

/*+ update */
UPDATE azure.api_management.api_operations
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND apiId = '{{ apiId }}'
AND operationId = '{{ operationId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified api_operations resource.

/*+ delete */
DELETE FROM azure.api_management.api_operations
WHERE If-Match = '{{ If-Match }}'
AND apiId = '{{ apiId }}'
AND operationId = '{{ operationId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';