Interface IngestionSettings


public interface IngestionSettings
Resource collection API of IngestionSettings.
  • Method Summary

    Modifier and Type
    Method
    Description
    define(String name)
    Begins definition for a new IngestionSetting resource.
    void
    delete(String ingestionSettingName)
    Deletes the ingestion settings for this subscription.
    void
    Deletes the ingestion settings for this subscription.
    com.azure.core.http.rest.Response<Void>
    deleteByIdWithResponse(String id, com.azure.core.util.Context context)
    Deletes the ingestion settings for this subscription.
    com.azure.core.http.rest.Response<Void>
    deleteWithResponse(String ingestionSettingName, com.azure.core.util.Context context)
    Deletes the ingestion settings for this subscription.
    get(String ingestionSettingName)
    Settings for ingesting security data and logs to correlate with resources associated with the subscription.
    Settings for ingesting security data and logs to correlate with resources associated with the subscription.
    com.azure.core.http.rest.Response<IngestionSetting>
    getByIdWithResponse(String id, com.azure.core.util.Context context)
    Settings for ingesting security data and logs to correlate with resources associated with the subscription.
    com.azure.core.http.rest.Response<IngestionSetting>
    getWithResponse(String ingestionSettingName, com.azure.core.util.Context context)
    Settings for ingesting security data and logs to correlate with resources associated with the subscription.
    com.azure.core.http.rest.PagedIterable<IngestionSetting>
    Settings for ingesting security data and logs to correlate with resources associated with the subscription.
    com.azure.core.http.rest.PagedIterable<IngestionSetting>
    list(com.azure.core.util.Context context)
    Settings for ingesting security data and logs to correlate with resources associated with the subscription.
    listConnectionStrings(String ingestionSettingName)
    Connection strings for ingesting security scan logs and data.
    com.azure.core.http.rest.Response<ConnectionStrings>
    listConnectionStringsWithResponse(String ingestionSettingName, com.azure.core.util.Context context)
    Connection strings for ingesting security scan logs and data.
    listTokens(String ingestionSettingName)
    Returns the token that is used for correlating ingested telemetry with the resources in the subscription.
    com.azure.core.http.rest.Response<IngestionSettingToken>
    listTokensWithResponse(String ingestionSettingName, com.azure.core.util.Context context)
    Returns the token that is used for correlating ingested telemetry with the resources in the subscription.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<IngestionSetting> list()
      Settings for ingesting security data and logs to correlate with resources associated with the subscription.
      Returns:
      list of ingestion settings as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • list

      com.azure.core.http.rest.PagedIterable<IngestionSetting> list(com.azure.core.util.Context context)
      Settings for ingesting security data and logs to correlate with resources associated with the subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      list of ingestion settings as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • get

      IngestionSetting get(String ingestionSettingName)
      Settings for ingesting security data and logs to correlate with resources associated with the subscription.
      Parameters:
      ingestionSettingName - Name of the ingestion setting.
      Returns:
      configures how to correlate scan data and logs with resources associated with the subscription.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getWithResponse

      com.azure.core.http.rest.Response<IngestionSetting> getWithResponse(String ingestionSettingName, com.azure.core.util.Context context)
      Settings for ingesting security data and logs to correlate with resources associated with the subscription.
      Parameters:
      ingestionSettingName - Name of the ingestion setting.
      context - The context to associate with this operation.
      Returns:
      configures how to correlate scan data and logs with resources associated with the subscription along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • delete

      void delete(String ingestionSettingName)
      Deletes the ingestion settings for this subscription.
      Parameters:
      ingestionSettingName - Name of the ingestion setting.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String ingestionSettingName, com.azure.core.util.Context context)
      Deletes the ingestion settings for this subscription.
      Parameters:
      ingestionSettingName - Name of the ingestion setting.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listTokens

      IngestionSettingToken listTokens(String ingestionSettingName)
      Returns the token that is used for correlating ingested telemetry with the resources in the subscription.
      Parameters:
      ingestionSettingName - Name of the ingestion setting.
      Returns:
      configures how to correlate scan data and logs with resources associated with the subscription.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listTokensWithResponse

      com.azure.core.http.rest.Response<IngestionSettingToken> listTokensWithResponse(String ingestionSettingName, com.azure.core.util.Context context)
      Returns the token that is used for correlating ingested telemetry with the resources in the subscription.
      Parameters:
      ingestionSettingName - Name of the ingestion setting.
      context - The context to associate with this operation.
      Returns:
      configures how to correlate scan data and logs with resources associated with the subscription along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listConnectionStrings

      ConnectionStrings listConnectionStrings(String ingestionSettingName)
      Connection strings for ingesting security scan logs and data.
      Parameters:
      ingestionSettingName - Name of the ingestion setting.
      Returns:
      connection string for ingesting security data and logs.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listConnectionStringsWithResponse

      com.azure.core.http.rest.Response<ConnectionStrings> listConnectionStringsWithResponse(String ingestionSettingName, com.azure.core.util.Context context)
      Connection strings for ingesting security scan logs and data.
      Parameters:
      ingestionSettingName - Name of the ingestion setting.
      context - The context to associate with this operation.
      Returns:
      connection string for ingesting security data and logs along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getById

      IngestionSetting getById(String id)
      Settings for ingesting security data and logs to correlate with resources associated with the subscription.
      Parameters:
      id - the resource ID.
      Returns:
      configures how to correlate scan data and logs with resources associated with the subscription along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getByIdWithResponse

      com.azure.core.http.rest.Response<IngestionSetting> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Settings for ingesting security data and logs to correlate with resources associated with the subscription.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      configures how to correlate scan data and logs with resources associated with the subscription along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteById

      void deleteById(String id)
      Deletes the ingestion settings for this subscription.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes the ingestion settings for this subscription.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • define

      Begins definition for a new IngestionSetting resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new IngestionSetting definition.