Package version:

Interface ConnectedEnvironments

Interface representing a ConnectedEnvironments.

Hierarchy

ConnectedEnvironments

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait checkNameAvailability get listByResourceGroup listBySubscription update

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, connectedEnvironmentName: string, environmentEnvelope: ConnectedEnvironment, options?: ConnectedEnvironmentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ConnectedEnvironment>, ConnectedEnvironment>>
Creates or updates an connectedEnvironment.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- connectedEnvironmentName: string
  
  Name of the connectedEnvironment.
- environmentEnvelope: ConnectedEnvironment
  
  Configuration details of the connectedEnvironment.
- Optional options: ConnectedEnvironmentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ConnectedEnvironment>, ConnectedEnvironment>>
- Defined in operationsInterfaces/connectedEnvironments.ts:64

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, connectedEnvironmentName: string, environmentEnvelope: ConnectedEnvironment, options?: ConnectedEnvironmentsCreateOrUpdateOptionalParams): Promise<ConnectedEnvironment>
Creates or updates an connectedEnvironment.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- connectedEnvironmentName: string
  
  Name of the connectedEnvironment.
- environmentEnvelope: ConnectedEnvironment
  
  Configuration details of the connectedEnvironment.
- Optional options: ConnectedEnvironmentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ConnectedEnvironment>
- Defined in operationsInterfaces/connectedEnvironments.ts:82

beginDelete

beginDelete(resourceGroupName: string, connectedEnvironmentName: string, options?: ConnectedEnvironmentsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Delete an connectedEnvironment.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- connectedEnvironmentName: string
  
  Name of the connectedEnvironment.
- Optional options: ConnectedEnvironmentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/connectedEnvironments.ts:94

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, connectedEnvironmentName: string, options?: ConnectedEnvironmentsDeleteOptionalParams): Promise<void>
Delete an connectedEnvironment.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- connectedEnvironmentName: string
  
  Name of the connectedEnvironment.
- Optional options: ConnectedEnvironmentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/connectedEnvironments.ts:105

checkNameAvailability

checkNameAvailability(resourceGroupName: string, connectedEnvironmentName: string, checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: ConnectedEnvironmentsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>
Checks if resource connectedEnvironmentName is available.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- connectedEnvironmentName: string
  
  Name of the Managed Environment.
- checkNameAvailabilityRequest: CheckNameAvailabilityRequest
  
  The check connectedEnvironmentName availability request.
- Optional options: ConnectedEnvironmentsCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<CheckNameAvailabilityResponse>
- Defined in operationsInterfaces/connectedEnvironments.ts:128

get

get(resourceGroupName: string, connectedEnvironmentName: string, options?: ConnectedEnvironmentsGetOptionalParams): Promise<ConnectedEnvironment>
Get the properties of an connectedEnvironment.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- connectedEnvironmentName: string
  
  Name of the connectedEnvironment.
- Optional options: ConnectedEnvironmentsGetOptionalParams
  
  The options parameters.
Returns Promise<ConnectedEnvironment>
- Defined in operationsInterfaces/connectedEnvironments.ts:52

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ConnectedEnvironmentsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ConnectedEnvironment>
Get all connectedEnvironments in a resource group.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: ConnectedEnvironmentsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ConnectedEnvironment>
- Defined in operationsInterfaces/connectedEnvironments.ts:42

listBySubscription

listBySubscription(options?: ConnectedEnvironmentsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ConnectedEnvironment>
Get all connectedEnvironments for a subscription.
Parameters
- Optional options: ConnectedEnvironmentsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ConnectedEnvironment>
- Defined in operationsInterfaces/connectedEnvironments.ts:34

update

update(resourceGroupName: string, connectedEnvironmentName: string, options?: ConnectedEnvironmentsUpdateOptionalParams): Promise<ConnectedEnvironment>
Patches a Managed Environment. Only patching of tags is supported currently
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- connectedEnvironmentName: string
  
  Name of the connectedEnvironment.
- Optional options: ConnectedEnvironmentsUpdateOptionalParams
  
  The options parameters.
Returns Promise<ConnectedEnvironment>
- Defined in operationsInterfaces/connectedEnvironments.ts:116

Interface ConnectedEnvironments

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

connectedEnvironmentName: string

environmentEnvelope: ConnectedEnvironment

Optional options: ConnectedEnvironmentsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ConnectedEnvironment>, ConnectedEnvironment>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

connectedEnvironmentName: string

environmentEnvelope: ConnectedEnvironment

Optional options: ConnectedEnvironmentsCreateOrUpdateOptionalParams

Returns Promise<ConnectedEnvironment>

beginDelete

Parameters

resourceGroupName: string

connectedEnvironmentName: string

Optional options: ConnectedEnvironmentsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

connectedEnvironmentName: string

Optional options: ConnectedEnvironmentsDeleteOptionalParams

Returns Promise<void>

checkNameAvailability

Parameters

resourceGroupName: string

connectedEnvironmentName: string

checkNameAvailabilityRequest: CheckNameAvailabilityRequest

Optional options: ConnectedEnvironmentsCheckNameAvailabilityOptionalParams

Returns Promise<CheckNameAvailabilityResponse>

get

Parameters

resourceGroupName: string

connectedEnvironmentName: string

Optional options: ConnectedEnvironmentsGetOptionalParams

Returns Promise<ConnectedEnvironment>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: ConnectedEnvironmentsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<ConnectedEnvironment>

listBySubscription

Parameters

Optional options: ConnectedEnvironmentsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<ConnectedEnvironment>

update

Parameters

resourceGroupName: string

connectedEnvironmentName: string

Optional options: ConnectedEnvironmentsUpdateOptionalParams

Returns Promise<ConnectedEnvironment>

Settings

Member Visibility

Theme

`Optional` options: ConnectedEnvironmentsCreateOrUpdateOptionalParams

`Optional` options: ConnectedEnvironmentsCreateOrUpdateOptionalParams

`Optional` options: ConnectedEnvironmentsDeleteOptionalParams

`Optional` options: ConnectedEnvironmentsDeleteOptionalParams

`Optional` options: ConnectedEnvironmentsCheckNameAvailabilityOptionalParams

`Optional` options: ConnectedEnvironmentsGetOptionalParams

`Optional` options: ConnectedEnvironmentsListByResourceGroupOptionalParams

`Optional` options: ConnectedEnvironmentsListBySubscriptionOptionalParams

`Optional` options: ConnectedEnvironmentsUpdateOptionalParams