Interface ApiKeysClient


  • public interface ApiKeysClient
    An instance of this class provides access to all the operations defined in ApiKeysClient.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponentApiKeyInner> list​(String resourceGroupName,
                                                                                             String resourceName)
        Gets a list of API keys of an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        Returns:
        a list of API keys of an Application Insights component 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.
      • list

        com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponentApiKeyInner> list​(String resourceGroupName,
                                                                                             String resourceName,
                                                                                             com.azure.core.util.Context context)
        Gets a list of API keys of an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        context - The context to associate with this operation.
        Returns:
        a list of API keys of an Application Insights component 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.
      • create

        ApplicationInsightsComponentApiKeyInner create​(String resourceGroupName,
                                                       String resourceName,
                                                       ApiKeyRequest apiKeyProperties)
        Create an API Key of an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        apiKeyProperties - Properties that need to be specified to create an API key of a Application Insights component.
        Returns:
        properties that define an API key of an Application Insights Component.
        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.
      • createWithResponse

        com.azure.core.http.rest.Response<ApplicationInsightsComponentApiKeyInner> createWithResponse​(String resourceGroupName,
                                                                                                      String resourceName,
                                                                                                      ApiKeyRequest apiKeyProperties,
                                                                                                      com.azure.core.util.Context context)
        Create an API Key of an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        apiKeyProperties - Properties that need to be specified to create an API key of a Application Insights component.
        context - The context to associate with this operation.
        Returns:
        properties that define an API key of an Application Insights Component 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

        ApplicationInsightsComponentApiKeyInner delete​(String resourceGroupName,
                                                       String resourceName,
                                                       String keyId)
        Delete an API Key of an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        keyId - The API Key ID. This is unique within a Application Insights component.
        Returns:
        properties that define an API key of an Application Insights Component.
        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<ApplicationInsightsComponentApiKeyInner> deleteWithResponse​(String resourceGroupName,
                                                                                                      String resourceName,
                                                                                                      String keyId,
                                                                                                      com.azure.core.util.Context context)
        Delete an API Key of an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        keyId - The API Key ID. This is unique within a Application Insights component.
        context - The context to associate with this operation.
        Returns:
        properties that define an API key of an Application Insights Component 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.
      • get

        ApplicationInsightsComponentApiKeyInner get​(String resourceGroupName,
                                                    String resourceName,
                                                    String keyId)
        Get the API Key for this key id.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        keyId - The API Key ID. This is unique within a Application Insights component.
        Returns:
        the API Key for this key 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.
      • getWithResponse

        com.azure.core.http.rest.Response<ApplicationInsightsComponentApiKeyInner> getWithResponse​(String resourceGroupName,
                                                                                                   String resourceName,
                                                                                                   String keyId,
                                                                                                   com.azure.core.util.Context context)
        Get the API Key for this key id.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        keyId - The API Key ID. This is unique within a Application Insights component.
        context - The context to associate with this operation.
        Returns:
        the API Key for this key id 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.