All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.apimanagement.DiagnosticArgs Maven / Gradle / Ivy

Go to download

A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.

There is a newer version: 6.10.0-alpha.1731737215
Show newest version
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.azure.apimanagement;

import com.pulumi.azure.apimanagement.inputs.DiagnosticBackendRequestArgs;
import com.pulumi.azure.apimanagement.inputs.DiagnosticBackendResponseArgs;
import com.pulumi.azure.apimanagement.inputs.DiagnosticFrontendRequestArgs;
import com.pulumi.azure.apimanagement.inputs.DiagnosticFrontendResponseArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Double;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class DiagnosticArgs extends com.pulumi.resources.ResourceArgs {

    public static final DiagnosticArgs Empty = new DiagnosticArgs();

    /**
     * Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
     * 
     */
    @Import(name="alwaysLogErrors")
    private @Nullable Output alwaysLogErrors;

    /**
     * @return Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
     * 
     */
    public Optional> alwaysLogErrors() {
        return Optional.ofNullable(this.alwaysLogErrors);
    }

    /**
     * The id of the target API Management Logger where the API Management Diagnostic should be saved.
     * 
     */
    @Import(name="apiManagementLoggerId", required=true)
    private Output apiManagementLoggerId;

    /**
     * @return The id of the target API Management Logger where the API Management Diagnostic should be saved.
     * 
     */
    public Output apiManagementLoggerId() {
        return this.apiManagementLoggerId;
    }

    /**
     * The Name of the API Management Service where this Diagnostic should be created. Changing this forces a new resource to be created.
     * 
     */
    @Import(name="apiManagementName", required=true)
    private Output apiManagementName;

    /**
     * @return The Name of the API Management Service where this Diagnostic should be created. Changing this forces a new resource to be created.
     * 
     */
    public Output apiManagementName() {
        return this.apiManagementName;
    }

    /**
     * A `backend_request` block as defined below.
     * 
     */
    @Import(name="backendRequest")
    private @Nullable Output backendRequest;

    /**
     * @return A `backend_request` block as defined below.
     * 
     */
    public Optional> backendRequest() {
        return Optional.ofNullable(this.backendRequest);
    }

    /**
     * A `backend_response` block as defined below.
     * 
     */
    @Import(name="backendResponse")
    private @Nullable Output backendResponse;

    /**
     * @return A `backend_response` block as defined below.
     * 
     */
    public Optional> backendResponse() {
        return Optional.ofNullable(this.backendResponse);
    }

    /**
     * A `frontend_request` block as defined below.
     * 
     */
    @Import(name="frontendRequest")
    private @Nullable Output frontendRequest;

    /**
     * @return A `frontend_request` block as defined below.
     * 
     */
    public Optional> frontendRequest() {
        return Optional.ofNullable(this.frontendRequest);
    }

    /**
     * A `frontend_response` block as defined below.
     * 
     */
    @Import(name="frontendResponse")
    private @Nullable Output frontendResponse;

    /**
     * @return A `frontend_response` block as defined below.
     * 
     */
    public Optional> frontendResponse() {
        return Optional.ofNullable(this.frontendResponse);
    }

    /**
     * The HTTP Correlation Protocol to use. Possible values are `None`, `Legacy` or `W3C`.
     * 
     */
    @Import(name="httpCorrelationProtocol")
    private @Nullable Output httpCorrelationProtocol;

    /**
     * @return The HTTP Correlation Protocol to use. Possible values are `None`, `Legacy` or `W3C`.
     * 
     */
    public Optional> httpCorrelationProtocol() {
        return Optional.ofNullable(this.httpCorrelationProtocol);
    }

    /**
     * The diagnostic identifier for the API Management Service. At this time the supported values are `applicationinsights` and `azuremonitor`. Changing this forces a new resource to be created.
     * 
     */
    @Import(name="identifier", required=true)
    private Output identifier;

    /**
     * @return The diagnostic identifier for the API Management Service. At this time the supported values are `applicationinsights` and `azuremonitor`. Changing this forces a new resource to be created.
     * 
     */
    public Output identifier() {
        return this.identifier;
    }

    /**
     * Log client IP address.
     * 
     */
    @Import(name="logClientIp")
    private @Nullable Output logClientIp;

    /**
     * @return Log client IP address.
     * 
     */
    public Optional> logClientIp() {
        return Optional.ofNullable(this.logClientIp);
    }

    /**
     * The format of the Operation Name for Application Insights telemetries. Possible values are `Name`, and `Url`.
     * 
     */
    @Import(name="operationNameFormat")
    private @Nullable Output operationNameFormat;

    /**
     * @return The format of the Operation Name for Application Insights telemetries. Possible values are `Name`, and `Url`.
     * 
     */
    public Optional> operationNameFormat() {
        return Optional.ofNullable(this.operationNameFormat);
    }

    /**
     * The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
     * 
     */
    @Import(name="resourceGroupName", required=true)
    private Output resourceGroupName;

    /**
     * @return The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
     * 
     */
    public Output resourceGroupName() {
        return this.resourceGroupName;
    }

    /**
     * Sampling (%). For high traffic APIs, please read this [documentation](https://docs.microsoft.com/azure/api-management/api-management-howto-app-insights#performance-implications-and-log-sampling) to understand performance implications and log sampling. Valid values are between `0.0` and `100.0`.
     * 
     */
    @Import(name="samplingPercentage")
    private @Nullable Output samplingPercentage;

    /**
     * @return Sampling (%). For high traffic APIs, please read this [documentation](https://docs.microsoft.com/azure/api-management/api-management-howto-app-insights#performance-implications-and-log-sampling) to understand performance implications and log sampling. Valid values are between `0.0` and `100.0`.
     * 
     */
    public Optional> samplingPercentage() {
        return Optional.ofNullable(this.samplingPercentage);
    }

    /**
     * Logging verbosity. Possible values are `verbose`, `information` or `error`.
     * 
     */
    @Import(name="verbosity")
    private @Nullable Output verbosity;

    /**
     * @return Logging verbosity. Possible values are `verbose`, `information` or `error`.
     * 
     */
    public Optional> verbosity() {
        return Optional.ofNullable(this.verbosity);
    }

    private DiagnosticArgs() {}

    private DiagnosticArgs(DiagnosticArgs $) {
        this.alwaysLogErrors = $.alwaysLogErrors;
        this.apiManagementLoggerId = $.apiManagementLoggerId;
        this.apiManagementName = $.apiManagementName;
        this.backendRequest = $.backendRequest;
        this.backendResponse = $.backendResponse;
        this.frontendRequest = $.frontendRequest;
        this.frontendResponse = $.frontendResponse;
        this.httpCorrelationProtocol = $.httpCorrelationProtocol;
        this.identifier = $.identifier;
        this.logClientIp = $.logClientIp;
        this.operationNameFormat = $.operationNameFormat;
        this.resourceGroupName = $.resourceGroupName;
        this.samplingPercentage = $.samplingPercentage;
        this.verbosity = $.verbosity;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(DiagnosticArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private DiagnosticArgs $;

        public Builder() {
            $ = new DiagnosticArgs();
        }

        public Builder(DiagnosticArgs defaults) {
            $ = new DiagnosticArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param alwaysLogErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
         * 
         * @return builder
         * 
         */
        public Builder alwaysLogErrors(@Nullable Output alwaysLogErrors) {
            $.alwaysLogErrors = alwaysLogErrors;
            return this;
        }

        /**
         * @param alwaysLogErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
         * 
         * @return builder
         * 
         */
        public Builder alwaysLogErrors(Boolean alwaysLogErrors) {
            return alwaysLogErrors(Output.of(alwaysLogErrors));
        }

        /**
         * @param apiManagementLoggerId The id of the target API Management Logger where the API Management Diagnostic should be saved.
         * 
         * @return builder
         * 
         */
        public Builder apiManagementLoggerId(Output apiManagementLoggerId) {
            $.apiManagementLoggerId = apiManagementLoggerId;
            return this;
        }

        /**
         * @param apiManagementLoggerId The id of the target API Management Logger where the API Management Diagnostic should be saved.
         * 
         * @return builder
         * 
         */
        public Builder apiManagementLoggerId(String apiManagementLoggerId) {
            return apiManagementLoggerId(Output.of(apiManagementLoggerId));
        }

        /**
         * @param apiManagementName The Name of the API Management Service where this Diagnostic should be created. Changing this forces a new resource to be created.
         * 
         * @return builder
         * 
         */
        public Builder apiManagementName(Output apiManagementName) {
            $.apiManagementName = apiManagementName;
            return this;
        }

        /**
         * @param apiManagementName The Name of the API Management Service where this Diagnostic should be created. Changing this forces a new resource to be created.
         * 
         * @return builder
         * 
         */
        public Builder apiManagementName(String apiManagementName) {
            return apiManagementName(Output.of(apiManagementName));
        }

        /**
         * @param backendRequest A `backend_request` block as defined below.
         * 
         * @return builder
         * 
         */
        public Builder backendRequest(@Nullable Output backendRequest) {
            $.backendRequest = backendRequest;
            return this;
        }

        /**
         * @param backendRequest A `backend_request` block as defined below.
         * 
         * @return builder
         * 
         */
        public Builder backendRequest(DiagnosticBackendRequestArgs backendRequest) {
            return backendRequest(Output.of(backendRequest));
        }

        /**
         * @param backendResponse A `backend_response` block as defined below.
         * 
         * @return builder
         * 
         */
        public Builder backendResponse(@Nullable Output backendResponse) {
            $.backendResponse = backendResponse;
            return this;
        }

        /**
         * @param backendResponse A `backend_response` block as defined below.
         * 
         * @return builder
         * 
         */
        public Builder backendResponse(DiagnosticBackendResponseArgs backendResponse) {
            return backendResponse(Output.of(backendResponse));
        }

        /**
         * @param frontendRequest A `frontend_request` block as defined below.
         * 
         * @return builder
         * 
         */
        public Builder frontendRequest(@Nullable Output frontendRequest) {
            $.frontendRequest = frontendRequest;
            return this;
        }

        /**
         * @param frontendRequest A `frontend_request` block as defined below.
         * 
         * @return builder
         * 
         */
        public Builder frontendRequest(DiagnosticFrontendRequestArgs frontendRequest) {
            return frontendRequest(Output.of(frontendRequest));
        }

        /**
         * @param frontendResponse A `frontend_response` block as defined below.
         * 
         * @return builder
         * 
         */
        public Builder frontendResponse(@Nullable Output frontendResponse) {
            $.frontendResponse = frontendResponse;
            return this;
        }

        /**
         * @param frontendResponse A `frontend_response` block as defined below.
         * 
         * @return builder
         * 
         */
        public Builder frontendResponse(DiagnosticFrontendResponseArgs frontendResponse) {
            return frontendResponse(Output.of(frontendResponse));
        }

        /**
         * @param httpCorrelationProtocol The HTTP Correlation Protocol to use. Possible values are `None`, `Legacy` or `W3C`.
         * 
         * @return builder
         * 
         */
        public Builder httpCorrelationProtocol(@Nullable Output httpCorrelationProtocol) {
            $.httpCorrelationProtocol = httpCorrelationProtocol;
            return this;
        }

        /**
         * @param httpCorrelationProtocol The HTTP Correlation Protocol to use. Possible values are `None`, `Legacy` or `W3C`.
         * 
         * @return builder
         * 
         */
        public Builder httpCorrelationProtocol(String httpCorrelationProtocol) {
            return httpCorrelationProtocol(Output.of(httpCorrelationProtocol));
        }

        /**
         * @param identifier The diagnostic identifier for the API Management Service. At this time the supported values are `applicationinsights` and `azuremonitor`. Changing this forces a new resource to be created.
         * 
         * @return builder
         * 
         */
        public Builder identifier(Output identifier) {
            $.identifier = identifier;
            return this;
        }

        /**
         * @param identifier The diagnostic identifier for the API Management Service. At this time the supported values are `applicationinsights` and `azuremonitor`. Changing this forces a new resource to be created.
         * 
         * @return builder
         * 
         */
        public Builder identifier(String identifier) {
            return identifier(Output.of(identifier));
        }

        /**
         * @param logClientIp Log client IP address.
         * 
         * @return builder
         * 
         */
        public Builder logClientIp(@Nullable Output logClientIp) {
            $.logClientIp = logClientIp;
            return this;
        }

        /**
         * @param logClientIp Log client IP address.
         * 
         * @return builder
         * 
         */
        public Builder logClientIp(Boolean logClientIp) {
            return logClientIp(Output.of(logClientIp));
        }

        /**
         * @param operationNameFormat The format of the Operation Name for Application Insights telemetries. Possible values are `Name`, and `Url`.
         * 
         * @return builder
         * 
         */
        public Builder operationNameFormat(@Nullable Output operationNameFormat) {
            $.operationNameFormat = operationNameFormat;
            return this;
        }

        /**
         * @param operationNameFormat The format of the Operation Name for Application Insights telemetries. Possible values are `Name`, and `Url`.
         * 
         * @return builder
         * 
         */
        public Builder operationNameFormat(String operationNameFormat) {
            return operationNameFormat(Output.of(operationNameFormat));
        }

        /**
         * @param resourceGroupName The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
         * 
         * @return builder
         * 
         */
        public Builder resourceGroupName(Output resourceGroupName) {
            $.resourceGroupName = resourceGroupName;
            return this;
        }

        /**
         * @param resourceGroupName The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
         * 
         * @return builder
         * 
         */
        public Builder resourceGroupName(String resourceGroupName) {
            return resourceGroupName(Output.of(resourceGroupName));
        }

        /**
         * @param samplingPercentage Sampling (%). For high traffic APIs, please read this [documentation](https://docs.microsoft.com/azure/api-management/api-management-howto-app-insights#performance-implications-and-log-sampling) to understand performance implications and log sampling. Valid values are between `0.0` and `100.0`.
         * 
         * @return builder
         * 
         */
        public Builder samplingPercentage(@Nullable Output samplingPercentage) {
            $.samplingPercentage = samplingPercentage;
            return this;
        }

        /**
         * @param samplingPercentage Sampling (%). For high traffic APIs, please read this [documentation](https://docs.microsoft.com/azure/api-management/api-management-howto-app-insights#performance-implications-and-log-sampling) to understand performance implications and log sampling. Valid values are between `0.0` and `100.0`.
         * 
         * @return builder
         * 
         */
        public Builder samplingPercentage(Double samplingPercentage) {
            return samplingPercentage(Output.of(samplingPercentage));
        }

        /**
         * @param verbosity Logging verbosity. Possible values are `verbose`, `information` or `error`.
         * 
         * @return builder
         * 
         */
        public Builder verbosity(@Nullable Output verbosity) {
            $.verbosity = verbosity;
            return this;
        }

        /**
         * @param verbosity Logging verbosity. Possible values are `verbose`, `information` or `error`.
         * 
         * @return builder
         * 
         */
        public Builder verbosity(String verbosity) {
            return verbosity(Output.of(verbosity));
        }

        public DiagnosticArgs build() {
            if ($.apiManagementLoggerId == null) {
                throw new MissingRequiredPropertyException("DiagnosticArgs", "apiManagementLoggerId");
            }
            if ($.apiManagementName == null) {
                throw new MissingRequiredPropertyException("DiagnosticArgs", "apiManagementName");
            }
            if ($.identifier == null) {
                throw new MissingRequiredPropertyException("DiagnosticArgs", "identifier");
            }
            if ($.resourceGroupName == null) {
                throw new MissingRequiredPropertyException("DiagnosticArgs", "resourceGroupName");
            }
            return $;
        }
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy