deployments

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

Overview

Name	deployments
Type	Resource
Id	azure.api_center.deployments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
customProperties	object	The custom metadata defined for API catalog entities.
definitionId	string	API center-scoped definition resource ID.
description	string	Description of the deployment.
environmentId	string	API center-scoped environment resource ID.
server	object	The deployment server.
state	string	State of API deployment. Known values are: "active" and "inactive".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	API deployment title.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
customProperties	object	The custom metadata defined for API catalog entities.
definitionId	string	API center-scoped definition resource ID.
description	string	Description of the deployment.
environmentId	string	API center-scoped environment resource ID.
server	object	The deployment server.
state	string	State of API deployment. Known values are: "active" and "inactive".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	API deployment title.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, workspace_name, api_name, deployment_name, subscription_id		Returns details of the API deployment.
list	select	resource_group_name, service_name, workspace_name, api_name, subscription_id	$filter	Returns a collection of API deployments.
create_or_update	insert	resource_group_name, service_name, workspace_name, api_name, deployment_name, subscription_id		Creates new or updates existing API deployment.
create_or_update	replace	resource_group_name, service_name, workspace_name, api_name, deployment_name, subscription_id		Creates new or updates existing API deployment.
delete	delete	resource_group_name, service_name, workspace_name, api_name, deployment_name, subscription_id		Deletes API deployment.
head	exec	resource_group_name, service_name, workspace_name, api_name, deployment_name, subscription_id		Checks if specified API deployment exists.

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
api_name	string	The name of the API. Required.
deployment_name	string	The name of the API deployment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of Azure API Center service. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.
$filter	string	OData filter parameter. Default value is None.

SELECT examples

get

Returns details of the API deployment.

SELECT
id,
name,
customProperties,
definitionId,
description,
environmentId,
server,
state,
systemData,
title,
type
FROM azure.api_center.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND api_name = '{{ api_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a collection of API deployments.

SELECT
id,
name,
customProperties,
definitionId,
description,
environmentId,
server,
state,
systemData,
title,
type
FROM azure.api_center.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND api_name = '{{ api_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates new or updates existing API deployment.

INSERT INTO azure.api_center.deployments (
properties,
resource_group_name,
service_name,
workspace_name,
api_name,
deployment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_name }}',
'{{ api_name }}',
'{{ deployment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the deployments resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the deployments resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the deployments resource.
  - name: api_name
    value: "{{ api_name }}"
    description: Required parameter for the deployments resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the deployments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the deployments resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      title: "{{ title }}"
      description: "{{ description }}"
      environmentId: "{{ environmentId }}"
      definitionId: "{{ definitionId }}"
      state: "{{ state }}"
      server:
        runtimeUri:
          - "{{ runtimeUri }}"
      customProperties: "{{ customProperties }}"

REPLACE examples

create_or_update

Creates new or updates existing API deployment.

REPLACE azure.api_center.deployments
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND api_name = '{{ api_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes API deployment.

DELETE FROM azure.api_center.deployments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND api_name = '{{ api_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

head

Checks if specified API deployment exists.

EXEC azure.api_center.deployments.head 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@api_name='{{ api_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;