deployments

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

Overview

Name	deployments
Type	Resource
Id	azure.api_center.deployments

Fields

vw_deployments

Name	Datatype	Description
description	text	field from the properties object
apiName	text	field from the properties object
custom_properties	text	field from the properties object
definition_id	text	field from the properties object
deploymentName	text	field from the properties object
environment_id	text	field from the properties object
resourceGroupName	text	field from the properties object
server	text	field from the properties object
serviceName	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
title	text	field from the properties object
workspaceName	text	field from the properties object

deployments

Name	Datatype	Description
properties	object	API deployment entity properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiName, deploymentName, resourceGroupName, serviceName, subscriptionId, workspaceName	Returns details of the API deployment.
list	SELECT	apiName, resourceGroupName, serviceName, subscriptionId, workspaceName	Returns a collection of API deployments.
create_or_update	INSERT	apiName, deploymentName, resourceGroupName, serviceName, subscriptionId, workspaceName	Creates new or updates existing API deployment.
delete	DELETE	apiName, deploymentName, resourceGroupName, serviceName, subscriptionId, workspaceName	Deletes API deployment.

SELECT examples

Returns a collection of API deployments.

vw_deployments

SELECT
description,
apiName,
custom_properties,
definition_id,
deploymentName,
environment_id,
resourceGroupName,
server,
serviceName,
state,
subscriptionId,
title,
workspaceName
FROM azure.api_center.vw_deployments
WHERE apiName = '{{ apiName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

deployments

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_center.deployments (
apiName,
deploymentName,
resourceGroupName,
serviceName,
subscriptionId,
workspaceName,
properties
)
SELECT 
'{{ apiName }}',
'{{ deploymentName }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: title
          value: string
        - name: description
          value: string
        - name: environmentId
          value: string
        - name: definitionId
          value: string
        - name: state
          value: []
        - name: server
          value:
            - name: runtimeUri
              value:
                - []
        - name: customProperties
          value: []

DELETE example

Deletes the specified deployments resource.

/*+ delete */
DELETE FROM azure.api_center.deployments
WHERE apiName = '{{ apiName }}'
AND deploymentName = '{{ deploymentName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';