services

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

Overview

Name	services
Type	Resource
Id	azure.api_management.services

Fields

vw_services

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
additional_locations	text	field from the properties object
api_version_constraint	text	field from the properties object
certificates	text	field from the properties object
configuration_api	text	field from the properties object
created_at_utc	text	field from the properties object
custom_properties	text	field from the properties object
developer_portal_status	text	field from the properties object
developer_portal_url	text	field from the properties object
disable_gateway	text	field from the properties object
enable_client_certificate	text	field from the properties object
etag	text	ETag of the resource.
gateway_regional_url	text	field from the properties object
gateway_url	text	field from the properties object
hostname_configurations	text	field from the properties object
identity	text	Identity properties of the Api Management service resource.
legacy_portal_status	text	field from the properties object
location	text	Resource location.
management_api_url	text	field from the properties object
nat_gateway_state	text	field from the properties object
notification_sender_email	text	field from the properties object
outbound_public_ip_addresses	text	field from the properties object
platform_version	text	field from the properties object
portal_url	text	field from the properties object
private_endpoint_connections	text	field from the properties object
private_ip_addresses	text	field from the properties object
provisioning_state	text	field from the properties object
public_ip_address_id	text	field from the properties object
public_ip_addresses	text	field from the properties object
public_network_access	text	field from the properties object
publisher_email	text	field from the properties object
publisher_name	text	field from the properties object
resourceGroupName	text	field from the properties object
restore	text	field from the properties object
scm_url	text	field from the properties object
serviceName	text	field from the properties object
sku	text	API Management service resource SKU properties.
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
target_provisioning_state	text	field from the properties object
type	text	Resource type for API Management resource is set to Microsoft.ApiManagement.
virtual_network_configuration	text	field from the properties object
virtual_network_type	text	field from the properties object
zones	text	A list of availability zones denoting where the resource needs to come from.

services

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	ETag of the resource.
identity	object	Identity properties of the Api Management service resource.
location	string	Resource location.
properties	object	Properties of an API Management service resource description.
sku	object	API Management service resource SKU properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type for API Management resource is set to Microsoft.ApiManagement.
zones	array	A list of availability zones denoting where the resource needs to come from.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serviceName, subscriptionId	Gets an API Management service resource description.
list	SELECT	subscriptionId	Lists all API Management services within an Azure subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List all API Management services within a resource group.
create_or_update	INSERT	resourceGroupName, serviceName, subscriptionId, data__location, data__properties, data__sku	Creates or updates an API Management service. This is long running operation and could take several minutes to complete.
delete	DELETE	resourceGroupName, serviceName, subscriptionId	Deletes an existing API Management service.
update	UPDATE	resourceGroupName, serviceName, subscriptionId	Updates an existing API Management service.
apply_network_configuration_updates	EXEC	resourceGroupName, serviceName, subscriptionId	Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
backup	EXEC	resourceGroupName, serviceName, subscriptionId, data__backupName, data__containerName, data__storageAccount	Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
check_name_availability	EXEC	subscriptionId, data__name	Checks availability and correctness of a name for an API Management service.
migrate_to_stv2	EXEC	resourceGroupName, serviceName, subscriptionId	Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.
restore	EXEC	resourceGroupName, serviceName, subscriptionId, data__backupName, data__containerName, data__storageAccount	Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.

SELECT examples

Lists all API Management services within an Azure subscription.

vw_services

SELECT
id,
name,
additional_locations,
api_version_constraint,
certificates,
configuration_api,
created_at_utc,
custom_properties,
developer_portal_status,
developer_portal_url,
disable_gateway,
enable_client_certificate,
etag,
gateway_regional_url,
gateway_url,
hostname_configurations,
identity,
legacy_portal_status,
location,
management_api_url,
nat_gateway_state,
notification_sender_email,
outbound_public_ip_addresses,
platform_version,
portal_url,
private_endpoint_connections,
private_ip_addresses,
provisioning_state,
public_ip_address_id,
public_ip_addresses,
public_network_access,
publisher_email,
publisher_name,
resourceGroupName,
restore,
scm_url,
serviceName,
sku,
subscriptionId,
system_data,
tags,
target_provisioning_state,
type,
virtual_network_configuration,
virtual_network_type,
zones
FROM azure.api_management.vw_services
WHERE subscriptionId = '{{ subscriptionId }}';

services

SELECT
id,
name,
etag,
identity,
location,
properties,
sku,
systemData,
tags,
type,
zones
FROM azure.api_management.services
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.services (
resourceGroupName,
serviceName,
subscriptionId,
data__location,
data__properties,
data__sku,
properties,
sku,
identity,
location,
zones,
tags
)
SELECT 
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ data__sku }}',
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ location }}',
'{{ zones }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: publisherEmail
          value: string
        - name: publisherName
          value: string
        - name: notificationSenderEmail
          value: string
        - name: provisioningState
          value: string
        - name: targetProvisioningState
          value: string
        - name: createdAtUtc
          value: string
        - name: gatewayUrl
          value: string
        - name: gatewayRegionalUrl
          value: string
        - name: portalUrl
          value: string
        - name: managementApiUrl
          value: string
        - name: scmUrl
          value: string
        - name: developerPortalUrl
          value: string
        - name: hostnameConfigurations
          value:
            - - name: type
                value: string
              - name: hostName
                value: string
              - name: keyVaultId
                value: string
              - name: identityClientId
                value: string
              - name: encodedCertificate
                value: string
              - name: certificatePassword
                value: string
              - name: defaultSslBinding
                value: boolean
              - name: negotiateClientCertificate
                value: boolean
              - name: certificate
                value:
                  - name: expiry
                    value: string
                  - name: thumbprint
                    value: string
                  - name: subject
                    value: string
              - name: certificateSource
                value: string
              - name: certificateStatus
                value: string
        - name: publicIPAddresses
          value:
            - string
        - name: privateIPAddresses
          value:
            - string
        - name: publicIpAddressId
          value: string
        - name: publicNetworkAccess
          value: string
        - name: configurationApi
          value:
            - name: legacyApi
              value: string
        - name: virtualNetworkConfiguration
          value:
            - name: vnetid
              value: string
            - name: subnetname
              value: string
            - name: subnetResourceId
              value: string
        - name: additionalLocations
          value:
            - - name: location
                value: string
              - name: sku
                value:
                  - name: name
                    value: string
                  - name: capacity
                    value: integer
              - name: zones
                value:
                  - string
              - name: publicIPAddresses
                value:
                  - string
              - name: privateIPAddresses
                value:
                  - string
              - name: publicIpAddressId
                value: string
              - name: gatewayRegionalUrl
                value: string
              - name: natGatewayState
                value: string
              - name: outboundPublicIPAddresses
                value:
                  - string
              - name: disableGateway
                value: boolean
              - name: platformVersion
                value: string
        - name: customProperties
          value: object
        - name: certificates
          value:
            - - name: encodedCertificate
                value: string
              - name: certificatePassword
                value: string
              - name: storeName
                value: string
        - name: enableClientCertificate
          value: boolean
        - name: natGatewayState
          value: string
        - name: outboundPublicIPAddresses
          value:
            - string
        - name: disableGateway
          value: boolean
        - name: virtualNetworkType
          value: string
        - name: apiVersionConstraint
          value:
            - name: minApiVersion
              value: string
        - name: restore
          value: boolean
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: string
                  - name: groupIds
                    value:
                      - string
        - name: platformVersion
          value: string
        - name: legacyPortalStatus
          value: string
        - name: developerPortalStatus
          value: string
    - name: identity
      value:
        - name: type
          value: string
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: userAssignedIdentities
          value: object
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: location
      value: string
    - name: etag
      value: string
    - name: zones
      value:
        - string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: tags
      value: object

UPDATE example

Updates a services resource.

/*+ update */
UPDATE azure.api_management.services
SET 
properties = '{{ properties }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
zones = '{{ zones }}',
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified services resource.

/*+ delete */
DELETE FROM azure.api_management.services
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';