Environments interface

Interface representing a Environments.

Methods

beginCreateOrUpdate(string, string, EnvironmentCreateOrUpdateParametersUnion, EnvironmentsCreateOrUpdateOptionalParams)

Create or update an environment in the specified subscription and resource group.

beginCreateOrUpdateAndWait(string, string, EnvironmentCreateOrUpdateParametersUnion, EnvironmentsCreateOrUpdateOptionalParams)

Create or update an environment in the specified subscription and resource group.

beginUpdate(string, string, EnvironmentUpdateParametersUnion, EnvironmentsUpdateOptionalParams)

Updates the environment with the specified name in the specified subscription and resource group.

beginUpdateAndWait(string, string, EnvironmentUpdateParametersUnion, EnvironmentsUpdateOptionalParams)

Updates the environment with the specified name in the specified subscription and resource group.

delete(string, string, EnvironmentsDeleteOptionalParams)

Deletes the environment with the specified name in the specified subscription and resource group.

get(string, string, EnvironmentsGetOptionalParams)

Gets the environment with the specified name in the specified subscription and resource group.

listByResourceGroup(string, EnvironmentsListByResourceGroupOptionalParams)

Lists all the available environments associated with the subscription and within the specified resource group.

listBySubscription(EnvironmentsListBySubscriptionOptionalParams)

Lists all the available environments within a subscription, irrespective of the resource groups.

Method Details

beginCreateOrUpdate(string, string, EnvironmentCreateOrUpdateParametersUnion, EnvironmentsCreateOrUpdateOptionalParams)

Create or update an environment in the specified subscription and resource group.

function beginCreateOrUpdate(resourceGroupName: string, environmentName: string, parameters: EnvironmentCreateOrUpdateParametersUnion, options?: EnvironmentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<EnvironmentResourceUnion>, EnvironmentResourceUnion>>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

environmentName

string

Name of the environment

parameters
EnvironmentCreateOrUpdateParametersUnion

Parameters for creating an environment resource.

options
EnvironmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<EnvironmentResourceUnion>, EnvironmentResourceUnion>>

beginCreateOrUpdateAndWait(string, string, EnvironmentCreateOrUpdateParametersUnion, EnvironmentsCreateOrUpdateOptionalParams)

Create or update an environment in the specified subscription and resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, environmentName: string, parameters: EnvironmentCreateOrUpdateParametersUnion, options?: EnvironmentsCreateOrUpdateOptionalParams): Promise<EnvironmentResourceUnion>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

environmentName

string

Name of the environment

parameters
EnvironmentCreateOrUpdateParametersUnion

Parameters for creating an environment resource.

options
EnvironmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginUpdate(string, string, EnvironmentUpdateParametersUnion, EnvironmentsUpdateOptionalParams)

Updates the environment with the specified name in the specified subscription and resource group.

function beginUpdate(resourceGroupName: string, environmentName: string, environmentUpdateParameters: EnvironmentUpdateParametersUnion, options?: EnvironmentsUpdateOptionalParams): Promise<PollerLike<PollOperationState<EnvironmentResourceUnion>, EnvironmentResourceUnion>>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

environmentName

string

The name of the Time Series Insights environment associated with the specified resource group.

environmentUpdateParameters
EnvironmentUpdateParametersUnion

Request object that contains the updated information for the environment.

options
EnvironmentsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<EnvironmentResourceUnion>, EnvironmentResourceUnion>>

beginUpdateAndWait(string, string, EnvironmentUpdateParametersUnion, EnvironmentsUpdateOptionalParams)

Updates the environment with the specified name in the specified subscription and resource group.

function beginUpdateAndWait(resourceGroupName: string, environmentName: string, environmentUpdateParameters: EnvironmentUpdateParametersUnion, options?: EnvironmentsUpdateOptionalParams): Promise<EnvironmentResourceUnion>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

environmentName

string

The name of the Time Series Insights environment associated with the specified resource group.

environmentUpdateParameters
EnvironmentUpdateParametersUnion

Request object that contains the updated information for the environment.

options
EnvironmentsUpdateOptionalParams

The options parameters.

Returns

delete(string, string, EnvironmentsDeleteOptionalParams)

Deletes the environment with the specified name in the specified subscription and resource group.

function delete(resourceGroupName: string, environmentName: string, options?: EnvironmentsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

environmentName

string

The name of the Time Series Insights environment associated with the specified resource group.

options
EnvironmentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, EnvironmentsGetOptionalParams)

Gets the environment with the specified name in the specified subscription and resource group.

function get(resourceGroupName: string, environmentName: string, options?: EnvironmentsGetOptionalParams): Promise<EnvironmentResourceUnion>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

environmentName

string

The name of the Time Series Insights environment associated with the specified resource group.

options
EnvironmentsGetOptionalParams

The options parameters.

Returns

listByResourceGroup(string, EnvironmentsListByResourceGroupOptionalParams)

Lists all the available environments associated with the subscription and within the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: EnvironmentsListByResourceGroupOptionalParams): Promise<EnvironmentListResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

options
EnvironmentsListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(EnvironmentsListBySubscriptionOptionalParams)

Lists all the available environments within a subscription, irrespective of the resource groups.

function listBySubscription(options?: EnvironmentsListBySubscriptionOptionalParams): Promise<EnvironmentListResponse>

Parameters

options
EnvironmentsListBySubscriptionOptionalParams

The options parameters.

Returns