com.azure.resourcemanager.network.models.NetworkWatcher Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.resourcemanager.network.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.network.NetworkManager;
import com.azure.resourcemanager.network.fluent.models.NetworkWatcherInner;
import com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource;
import com.azure.resourcemanager.resources.fluentcore.arm.models.Resource;
import com.azure.resourcemanager.resources.fluentcore.model.Appliable;
import com.azure.resourcemanager.resources.fluentcore.model.Creatable;
import com.azure.resourcemanager.resources.fluentcore.model.Refreshable;
import com.azure.resourcemanager.resources.fluentcore.model.Updatable;
import reactor.core.publisher.Mono;

/** Entry point for Network Watcher API in Azure. */
@Fluent
public interface NetworkWatcher
    extends GroupableResource,
        Refreshable,
        Updatable,
        UpdatableWithTags {

    /** @return entry point to manage packet captures associated with network watcher */
    PacketCaptures packetCaptures();

    /** @return entry point to manage connection monitors associated with network watcher */
    ConnectionMonitors connectionMonitors();

    /**
     * First step specifying parameters to get topology of a resource group.
     *
     * @return current network topology by resource group
     */
    Topology.DefinitionStages.WithTargetResourceGroup topology();

    /**
     * Gets the configured and effective security group rules on the specified VM.
     *
     * @param vmId ID of the target VM
     * @return the configured and effective security group rules on the specified VM
     */
    SecurityGroupView getSecurityGroupView(String vmId);

    /**
     * Gets the configured and effective security group rules on the specified VM asynchronously.
     *
     * @param vmId ID of the target VM
     * @return the configured and effective security group rules on the specified VM
     */
    Mono getSecurityGroupViewAsync(String vmId);

    /**
     * Gets the information on the configuration of flow log.
     *
     * @param nsgId the name of the target resource group to get flow log status for
     * @return information on the configuration of flow log
     */
    FlowLogSettings getFlowLogSettings(String nsgId);

    /**
     * Gets the information on the configuration of flow log asynchronously.
     *
     * @param nsgId the name of the target resource group to get flow log status for
     * @return information on the configuration of flow log
     */
    Mono getFlowLogSettingsAsync(String nsgId);

    /**
     * First step specifying the parameters to get next hop for the VM.
     *
     * @return a stage to specify parameters for next hop
     */
    NextHop.DefinitionStages.WithTargetResource nextHop();

    /**
     * Verify IP flow from the specified VM to a location given the currently configured NSG rules.
     *
     * @return a stage to specify parameters for ip flow verification
     */
    VerificationIPFlow.DefinitionStages.WithTargetResource verifyIPFlow();

    /**
     * Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint
     * including another virtual machine or an arbitrary remote server.
     *
     * @return a stage to specify parameters for connectivity check
     */
    ConnectivityCheck.DefinitionStages.ToDestination checkConnectivity();

    /**
     * Initiate troubleshooting on a specified resource (virtual network gateway or virtual network gateway connection).
     *
     * @return troubleshooting result information
     */
    Troubleshooting.DefinitionStages.WithTargetResource troubleshoot();

    /**
     * Lists all available internet service providers for a specified Azure region.
     *
     * @return a stage to specify parameters for internet providers list
     */
    AvailableProviders.DefinitionStages.WithExecute availableProviders();

    /**
     * Gets the relative latency score for internet service providers from a specified location to Azure regions.
     *
     * @return a stage to specify parameters for internet providers list
     */
    AzureReachabilityReport.DefinitionStages.WithProviderLocation azureReachabilityReport();

    /** Container interface for all the definitions. */
    interface Definition extends DefinitionStages.Blank, DefinitionStages.WithGroup, DefinitionStages.WithCreate {
    }

    /** Grouping of network watcher definition stages. */
    interface DefinitionStages {
        /** The first stage of a network watcher definition. */
        interface Blank extends GroupableResource.DefinitionWithRegion {
        }

        /** The stage of the network watcher definition allowing to specify the resource group. */
        interface WithGroup extends GroupableResource.DefinitionStages.WithGroup {
        }

        /**
         * A network watcher with sufficient inputs to create a new network watcher in the cloud, but exposing
         * additional optional inputs to specify.
         */
        interface WithCreate extends Creatable, Resource.DefinitionWithTags {
        }
    }

    /** The template for update operation, containing all the settings that can be modified. */
    interface Update extends Appliable, Resource.UpdateWithTags {
    }
}