Workspaces interface

Package:

@azure/arm-apicenter

Interface representing a Workspaces.

Methods

createOrUpdate(string, string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)	Creates new or updates existing workspace.
delete(string, string, string, WorkspacesDeleteOptionalParams)	Deletes specified workspace.
get(string, string, string, WorkspacesGetOptionalParams)	Returns details of the workspace.
head(string, string, string, WorkspacesHeadOptionalParams)	Checks if specified workspace exists.
list(string, string, WorkspacesListOptionalParams)	Returns a collection of workspaces.

Method Details

createOrUpdate(string, string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)

Creates new or updates existing workspace.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, resource: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<WorkspacesCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

resource

Workspace

Resource create parameters.

options

WorkspacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WorkspacesCreateOrUpdateResponse>

delete(string, string, string, WorkspacesDeleteOptionalParams)

Deletes specified workspace.

function delete(resourceGroupName: string, serviceName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

options

WorkspacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, WorkspacesGetOptionalParams)

Returns details of the workspace.

function get(resourceGroupName: string, serviceName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<WorkspacesGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

options

WorkspacesGetOptionalParams

The options parameters.

Returns

Promise<WorkspacesGetResponse>

head(string, string, string, WorkspacesHeadOptionalParams)

Checks if specified workspace exists.

function head(resourceGroupName: string, serviceName: string, workspaceName: string, options?: WorkspacesHeadOptionalParams): Promise<WorkspacesHeadResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

workspaceName

string

The name of the workspace.

options

WorkspacesHeadOptionalParams

The options parameters.

Returns

Promise<WorkspacesHeadResponse>

list(string, string, WorkspacesListOptionalParams)

Returns a collection of workspaces.

function list(resourceGroupName: string, serviceName: string, options?: WorkspacesListOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

options

WorkspacesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>