Workspace interface
Interface representing a Workspace.
Methods
| create |
Creates a new workspace or updates an existing one. |
| delete(string, string, string, string, Workspace |
Deletes the specified workspace. |
| get(string, string, string, Workspace |
Gets the details of the workspace specified by its identifier. |
| get |
Gets the entity state (Etag) version of the workspace specified by its identifier. |
| list |
Lists all workspaces of the API Management service instance. |
| update(string, string, string, string, Workspace |
Updates the details of the workspace specified by its identifier. |
Method Details
createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)
Creates a new workspace or updates an existing one.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, parameters: WorkspaceContract, options?: WorkspaceCreateOrUpdateOptionalParams): Promise<WorkspaceCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- parameters
- WorkspaceContract
Create parameters.
The options parameters.
Returns
Promise<WorkspaceCreateOrUpdateResponse>
delete(string, string, string, string, WorkspaceDeleteOptionalParams)
Deletes the specified workspace.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, options?: WorkspaceDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- options
- WorkspaceDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, WorkspaceGetOptionalParams)
Gets the details of the workspace specified by its identifier.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetOptionalParams): Promise<WorkspaceGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- options
- WorkspaceGetOptionalParams
The options parameters.
Returns
Promise<WorkspaceGetResponse>
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the workspace specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetEntityTagOptionalParams): Promise<WorkspaceGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<WorkspaceGetEntityTagHeaders>
listByService(string, string, WorkspaceListByServiceOptionalParams)
Lists all workspaces of the API Management service instance.
function listByService(resourceGroupName: string, serviceName: string, options?: WorkspaceListByServiceOptionalParams): PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)
Updates the details of the workspace specified by its identifier.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, parameters: WorkspaceContract, options?: WorkspaceUpdateOptionalParams): Promise<WorkspaceUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters
- WorkspaceContract
Workspace Update parameters.
- options
- WorkspaceUpdateOptionalParams
The options parameters.
Returns
Promise<WorkspaceUpdateResponse>