Description

The editAzureApplicationInsights operation handles configuration related to AzureApplicationInsights model. 

HTTP request

PUT /api/fdm/v6/object/azureapplicationinsights/{objId}

Data Parameters

Parameter Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name True string
Field level constraints: cannot be null, cannot be blank or empty, length must be between 0 and 128 (inclusive). (Note: Additional constraints might exist)
description False string
Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
instrumentationKey False string A String that represents the key used on the backend to correlate to the correct customer instance of Azure application insights
region False string An ENUM value that represents Azure region into which this traffic is destined.
customURL False string A String object that indicates the URL. Applicable only for the CUSTOM Region value.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter Required Type Description
objId True string

Example

curl -X PUT \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "customURL": "string",
        "description": "string",
        "id": "string",
        "instrumentationKey": "string",
        "name": "string",
        "region": "DEFAULT",
        "type": "azureapplicationinsights",
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/azureapplicationinsights/{objId}"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def edit_azure_application_insights(client, obj_id, body):
    return client.DeviceMetrics.editAzureApplicationInsights(
        objId=obj_id,
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    obj_id = "string"
    body = {'customURL': 'string',
 'description': 'string',
 'id': 'string',
 'instrumentationKey': 'string',
 'name': 'string',
 'region': 'DEFAULT',
 'type': 'azureapplicationinsights',
 'version': 'string'}

    edit_azure_application_insights(client, obj_id, body)