Skip to content

Latest commit

 

History

History
175 lines (136 loc) · 6.44 KB

azure_custom_api_definition.md

File metadata and controls

175 lines (136 loc) · 6.44 KB

Document: "logicAppsManagementClient"

Path: "https://github.com/Azure/azure-rest-api-specs/blob/2fbb5118cd34f412a51d9bc8a274224b216763cf/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json")

CustomApiDefinition

A custom API

azure_custom_api_definition {
  api_version => "api_version",
  api_name => "api_name",
  custom_api => "customApi",
  etag => "etag (optional)",
  location => "location (optional)",
  properties => $azure_custom_api_properties_definition
  resource_group_name => "resource_group_name",
  subscription_id => "subscription_id",
  tags => "tags (optional)",
}
Name Type Required Description
api_version String true API Version
api_name String true API name
custom_api Hash true The custom API
etag String false Resource ETag
location String false Resource location
properties CustomApiPropertiesDefinition false
resource_group_name String true The resource group
subscription_id String true Subscription Id
tags String false

CustomApiPropertiesDefinition

Custom API properties

$azure_custom_api_properties_definition = {
  apiDefinitions => $azure_api_resource_definitions
  apiType => $azure_api_type
  backendService => $azure_api_resource_backend_service
  brandColor => "brandColor (optional)",
  capabilities => "capabilities (optional)",
  connectionParameters => "connectionParameters (optional)",
  description => "description (optional)",
  displayName => "displayName (optional)",
  iconUri => "iconUri (optional)",
  runtimeUrls => "runtimeUrls (optional)",
  swagger => "swagger (optional)",
  wsdlDefinition => $azure_wsdl_definition
}
Name Type Required Description
apiDefinitions ApiResourceDefinitions false
apiType ApiType false
backendService ApiResourceBackendService false
brandColor String false Brand color
capabilities Array false The custom API capabilities
connectionParameters Hash false Connection parameters
description String false The custom API description
displayName String false The display name
iconUri String false The icon URI
runtimeUrls Array false Runtime URLs
swagger Hash false The JSON representation of the swagger
wsdlDefinition WsdlDefinition false

ApiResourceDefinitions

API Definitions

$azure_api_resource_definitions = {
  modifiedSwaggerUrl => "modifiedSwaggerUrl (optional)",
  originalSwaggerUrl => "originalSwaggerUrl (optional)",
}
Name Type Required Description
modifiedSwaggerUrl String false The modified swagger URL
originalSwaggerUrl String false The original swagger URL

ApiType

The API type

$azure_api_type = {
}
Name Type Required Description

ApiResourceBackendService

The API backend service

$azure_api_resource_backend_service = {
  serviceUrl => "serviceUrl (optional)",
}
Name Type Required Description
serviceUrl String false The service URL

WsdlDefinition

The WSDL definition

$azure_wsdl_definition = {
  content => "content (optional)",
  importMethod => $azure_wsdl_import_method
  service => $azure_wsdl_service
  url => "url (optional)",
}
Name Type Required Description
content String false The WSDL content
importMethod WsdlImportMethod false
service WsdlService false
url String false The WSDL URL

WsdlImportMethod

The WSDL import method

$azure_wsdl_import_method = {
}
Name Type Required Description

WsdlService

The service with name and endpoint names

$azure_wsdl_service = {
  endpointQualifiedNames => "endpointQualifiedNames (optional)",
  qualifiedName => "qualifiedName",
}
Name Type Required Description
endpointQualifiedNames Array false List of the endpoints' qualified names
qualifiedName String true The service's qualified name

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the CustomApiDefinition

Operation Path Verb Description OperationID
Create /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Web/customApis/%{api_name} Put Creates or updates an existing custom API CustomApis_CreateOrUpdate
List - list all /subscriptions/%{subscription_id}/providers/Microsoft.Web/customApis Get Gets a list of all custom APIs for a subscription id CustomApis_List
List - get one /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Web/customApis/%{api_name} Get Gets a custom API by name for a specific subscription and resource group CustomApis_Get
List - get list using params /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Web/customApis Get Gets a list of all custom APIs in a subscription for a specific resource group CustomApis_ListByResourceGroup
Update /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Web/customApis/%{api_name} Put Creates or updates an existing custom API CustomApis_CreateOrUpdate
Delete /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Web/customApis/%{api_name} Delete Deletes a custom API from the resource group CustomApis_Delete