Package version:

Interface ManagedEnvironments

Interface representing a ManagedEnvironments.

interface ManagedEnvironments {
    beginCreateOrUpdate(resourceGroupName: string, environmentName: string, environmentEnvelope: ManagedEnvironment, options?: ManagedEnvironmentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedEnvironment>, ManagedEnvironment>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, environmentName: string, environmentEnvelope: ManagedEnvironment, options?: ManagedEnvironmentsCreateOrUpdateOptionalParams): Promise<ManagedEnvironment>;
    beginDelete(resourceGroupName: string, environmentName: string, options?: ManagedEnvironmentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, environmentName: string, options?: ManagedEnvironmentsDeleteOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, environmentName: string, environmentEnvelope: ManagedEnvironment, options?: ManagedEnvironmentsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedEnvironment>, ManagedEnvironment>>;
    beginUpdateAndWait(resourceGroupName: string, environmentName: string, environmentEnvelope: ManagedEnvironment, options?: ManagedEnvironmentsUpdateOptionalParams): Promise<ManagedEnvironment>;
    get(resourceGroupName: string, environmentName: string, options?: ManagedEnvironmentsGetOptionalParams): Promise<ManagedEnvironment>;
    getAuthToken(resourceGroupName: string, environmentName: string, options?: ManagedEnvironmentsGetAuthTokenOptionalParams): Promise<EnvironmentAuthToken>;
    listByResourceGroup(resourceGroupName: string, options?: ManagedEnvironmentsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedEnvironment>;
    listBySubscription(options?: ManagedEnvironmentsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ManagedEnvironment>;
    listWorkloadProfileStates(resourceGroupName: string, environmentName: string, options?: ManagedEnvironmentsListWorkloadProfileStatesOptionalParams): PagedAsyncIterableIterator<WorkloadProfileStates>;
}

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getAuthToken listByResourceGroup listBySubscription listWorkloadProfileStates

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, environmentName, environmentEnvelope, options?): Promise<SimplePollerLike<OperationState<ManagedEnvironment>, ManagedEnvironment>>
Creates or updates a Managed Environment used to host container apps.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Environment.
- environmentEnvelope: ManagedEnvironment
  Configuration details of the Environment.
- Optionaloptions: ManagedEnvironmentsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedEnvironment>, ManagedEnvironment>>
- Defined in operationsInterfaces/managedEnvironments.ts:76

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, environmentName, environmentEnvelope, options?): Promise<ManagedEnvironment>
Creates or updates a Managed Environment used to host container apps.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Environment.
- environmentEnvelope: ManagedEnvironment
  Configuration details of the Environment.
- Optionaloptions: ManagedEnvironmentsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<ManagedEnvironment>
- Defined in operationsInterfaces/managedEnvironments.ts:94

beginDelete

beginDelete(resourceGroupName, environmentName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Delete a Managed Environment if it does not have any container apps.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Environment.
- Optionaloptions: ManagedEnvironmentsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedEnvironments.ts:106

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, environmentName, options?): Promise<void>
Delete a Managed Environment if it does not have any container apps.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Environment.
- Optionaloptions: ManagedEnvironmentsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedEnvironments.ts:117

beginUpdate

beginUpdate(resourceGroupName, environmentName, environmentEnvelope, options?): Promise<SimplePollerLike<OperationState<ManagedEnvironment>, ManagedEnvironment>>
Patches a Managed Environment using JSON Merge Patch
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Environment.
- environmentEnvelope: ManagedEnvironment
  Configuration details of the Environment.
- Optionaloptions: ManagedEnvironmentsUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedEnvironment>, ManagedEnvironment>>
- Defined in operationsInterfaces/managedEnvironments.ts:129

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, environmentName, environmentEnvelope, options?): Promise<ManagedEnvironment>
Patches a Managed Environment using JSON Merge Patch
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Environment.
- environmentEnvelope: ManagedEnvironment
  Configuration details of the Environment.
- Optionaloptions: ManagedEnvironmentsUpdateOptionalParams
  The options parameters.
Returns Promise<ManagedEnvironment>
- Defined in operationsInterfaces/managedEnvironments.ts:147

get

get(resourceGroupName, environmentName, options?): Promise<ManagedEnvironment>
Get the properties of a Managed Environment used to host container apps.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Environment.
- Optionaloptions: ManagedEnvironmentsGetOptionalParams
  The options parameters.
Returns Promise<ManagedEnvironment>
- Defined in operationsInterfaces/managedEnvironments.ts:64

getAuthToken

getAuthToken(resourceGroupName, environmentName, options?): Promise<EnvironmentAuthToken>
Checks if resource name is available.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Managed Environment.
- Optionaloptions: ManagedEnvironmentsGetAuthTokenOptionalParams
  The options parameters.
Returns Promise<EnvironmentAuthToken>
- Defined in operationsInterfaces/managedEnvironments.ts:159

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<ManagedEnvironment>
Get all the Managed Environments in a resource group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- Optionaloptions: ManagedEnvironmentsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedEnvironment>
- Defined in operationsInterfaces/managedEnvironments.ts:43

listBySubscription

listBySubscription(options?): PagedAsyncIterableIterator<ManagedEnvironment>
Get all Managed Environments for a subscription.
Parameters
- Optionaloptions: ManagedEnvironmentsListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedEnvironment>
- Defined in operationsInterfaces/managedEnvironments.ts:35

listWorkloadProfileStates

listWorkloadProfileStates(resourceGroupName, environmentName, options?): PagedAsyncIterableIterator<WorkloadProfileStates>
Get all workload Profile States for a Managed Environment.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- environmentName: string
  Name of the Managed Environment.
- Optionaloptions: ManagedEnvironmentsListWorkloadProfileStatesOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<WorkloadProfileStates>
- Defined in operationsInterfaces/managedEnvironments.ts:53

Interface ManagedEnvironments

Index

Methods

Methods

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<ManagedEnvironment>, ManagedEnvironment>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<ManagedEnvironment>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<ManagedEnvironment>, ManagedEnvironment>>

beginUpdateAndWait

Parameters

Returns Promise<ManagedEnvironment>

get

Parameters

Returns Promise<ManagedEnvironment>

getAuthToken

Parameters

Returns Promise<EnvironmentAuthToken>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<ManagedEnvironment>

listBySubscription

Parameters

Returns PagedAsyncIterableIterator<ManagedEnvironment>

listWorkloadProfileStates

Parameters

Returns PagedAsyncIterableIterator<WorkloadProfileStates>

Settings