WorkspacesOperations interface
Interface representing a Workspaces operations.
Properties
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| create |
Create or update a workspace. |
| delete | Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag. |
| failback | Deactivates failover for the specified workspace. The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response. |
| failover | Activates failover for the specified workspace. The specified replication location must match the location of the enabled replication for this workspace. The failover operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response. |
| get | Gets a workspace instance. |
| getNSP | Gets a network security perimeter configuration. |
| list | Gets the workspaces in a subscription. |
| list |
Gets workspaces in a resource group. |
| listNSP | Gets a list of NSP configurations for specified workspace. |
| reconcileNSP | Reconcile network security perimeter configuration for Workspace resource. |
| update | Updates a workspace. |
Property Details
beginCreateOrUpdate
Warning
This API is now deprecated.
use createOrUpdate instead
beginCreateOrUpdate: (resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>Property Value
(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>
beginCreateOrUpdateAndWait
Warning
This API is now deprecated.
use createOrUpdate instead
beginCreateOrUpdateAndWait: (resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => Promise<Workspace>Property Value
(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => Promise<Workspace>
beginDelete
Warning
This API is now deprecated.
use delete instead
beginDelete: (resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait
Warning
This API is now deprecated.
use delete instead
beginDeleteAndWait: (resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams) => Promise<void>
beginFailback
Warning
This API is now deprecated.
use failback instead
beginFailback: (resourceGroupName: string, workspaceName: string, options?: WorkspacesFailbackOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, workspaceName: string, options?: WorkspacesFailbackOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginFailbackAndWait
Warning
This API is now deprecated.
use failback instead
beginFailbackAndWait: (resourceGroupName: string, workspaceName: string, options?: WorkspacesFailbackOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, workspaceName: string, options?: WorkspacesFailbackOptionalParams) => Promise<void>
beginFailover
Warning
This API is now deprecated.
use failover instead
beginFailover: (resourceGroupName: string, location: string, workspaceName: string, options?: WorkspacesFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, location: string, workspaceName: string, options?: WorkspacesFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginFailoverAndWait
Warning
This API is now deprecated.
use failover instead
beginFailoverAndWait: (resourceGroupName: string, location: string, workspaceName: string, options?: WorkspacesFailoverOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, location: string, workspaceName: string, options?: WorkspacesFailoverOptionalParams) => Promise<void>
beginReconcileNSP
Warning
This API is now deprecated.
use reconcileNSP instead
beginReconcileNSP: (resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesReconcileNSPOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesReconcileNSPOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginReconcileNSPAndWait
Warning
This API is now deprecated.
use reconcileNSP instead
beginReconcileNSPAndWait: (resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesReconcileNSPOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesReconcileNSPOptionalParams) => Promise<void>
createOrUpdate
Create or update a workspace.
createOrUpdate: (resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Workspace>, Workspace>Property Value
(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Workspace>, Workspace>
delete
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
delete: (resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>
failback
Deactivates failover for the specified workspace.
The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.
failback: (resourceGroupName: string, workspaceName: string, options?: WorkspacesFailbackOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, workspaceName: string, options?: WorkspacesFailbackOptionalParams) => PollerLike<OperationState<void>, void>
failover
Activates failover for the specified workspace.
The specified replication location must match the location of the enabled replication for this workspace. The failover operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.
failover: (resourceGroupName: string, location: string, workspaceName: string, options?: WorkspacesFailoverOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, location: string, workspaceName: string, options?: WorkspacesFailoverOptionalParams) => PollerLike<OperationState<void>, void>
get
Gets a workspace instance.
get: (resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams) => Promise<Workspace>Property Value
(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams) => Promise<Workspace>
getNSP
Gets a network security perimeter configuration.
getNSP: (resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesGetNSPOptionalParams) => Promise<NetworkSecurityPerimeterConfiguration>Property Value
(resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesGetNSPOptionalParams) => Promise<NetworkSecurityPerimeterConfiguration>
list
Gets the workspaces in a subscription.
list: (options?: WorkspacesListOptionalParams) => PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>Property Value
(options?: WorkspacesListOptionalParams) => PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>
listByResourceGroup
Gets workspaces in a resource group.
listByResourceGroup: (resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>Property Value
(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>
listNSP
Gets a list of NSP configurations for specified workspace.
listNSP: (resourceGroupName: string, workspaceName: string, options?: WorkspacesListNSPOptionalParams) => PagedAsyncIterableIterator<NetworkSecurityPerimeterConfiguration, NetworkSecurityPerimeterConfiguration[], PageSettings>Property Value
(resourceGroupName: string, workspaceName: string, options?: WorkspacesListNSPOptionalParams) => PagedAsyncIterableIterator<NetworkSecurityPerimeterConfiguration, NetworkSecurityPerimeterConfiguration[], PageSettings>
reconcileNSP
Reconcile network security perimeter configuration for Workspace resource.
reconcileNSP: (resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesReconcileNSPOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesReconcileNSPOptionalParams) => PollerLike<OperationState<void>, void>
update
Updates a workspace.
update: (resourceGroupName: string, workspaceName: string, parameters: WorkspacePatch, options?: WorkspacesUpdateOptionalParams) => Promise<Workspace>Property Value
(resourceGroupName: string, workspaceName: string, parameters: WorkspacePatch, options?: WorkspacesUpdateOptionalParams) => Promise<Workspace>