Package com.azure.resourcemanager.applicationinsights.models

Interface ApiKeys

public interface ApiKeys

Resource collection API of ApiKeys.

Method Summary

Modifier and Type	Method	Description
ApplicationInsightsComponentApiKey	create(String resourceGroupName, String resourceName, ApiKeyRequest apiKeyProperties)	Create an API Key of an Application Insights component.
com.azure.core.http.rest.Response<ApplicationInsightsComponentApiKey>	createWithResponse(String resourceGroupName, String resourceName, ApiKeyRequest apiKeyProperties, com.azure.core.util.Context context)	Create an API Key of an Application Insights component.
ApplicationInsightsComponentApiKey	delete(String resourceGroupName, String resourceName, String keyId)	Delete an API Key of an Application Insights component.
com.azure.core.http.rest.Response<ApplicationInsightsComponentApiKey>	deleteWithResponse(String resourceGroupName, String resourceName, String keyId, com.azure.core.util.Context context)	Delete an API Key of an Application Insights component.
ApplicationInsightsComponentApiKey	get(String resourceGroupName, String resourceName, String keyId)	Get the API Key for this key id.
com.azure.core.http.rest.Response<ApplicationInsightsComponentApiKey>	getWithResponse(String resourceGroupName, String resourceName, String keyId, com.azure.core.util.Context context)	Get the API Key for this key id.
com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponentApiKey>	list(String resourceGroupName, String resourceName)	Gets a list of API keys of an Application Insights component.
com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponentApiKey>	list(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Gets a list of API keys of an Application Insights component.

Method Detail

list

com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponentApiKey> 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<ApplicationInsightsComponentApiKey> 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

ApplicationInsightsComponentApiKey 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<ApplicationInsightsComponentApiKey> 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

ApplicationInsightsComponentApiKey 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<ApplicationInsightsComponentApiKey> 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

ApplicationInsightsComponentApiKey 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<ApplicationInsightsComponentApiKey> 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.