Environments interface
Interface representing a Environments.
Methods
| create |
Creates new or updates existing environment. |
| delete(string, string, string, string, Environments |
Deletes the environment. |
| get(string, string, string, string, Environments |
Returns details of the environment. |
| head(string, string, string, string, Environments |
Checks if specified environment exists. |
| list(string, string, string, Environments |
Returns a collection of environments. |
Method Details
createOrUpdate(string, string, string, string, Environment, EnvironmentsCreateOrUpdateOptionalParams)
Creates new or updates existing environment.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, environmentName: string, resource: Environment, options?: EnvironmentsCreateOrUpdateOptionalParams): Promise<EnvironmentsCreateOrUpdateResponse>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.
- environmentName
-
string
The name of the environment.
- resource
- Environment
Resource create parameters.
The options parameters.
Returns
Promise<EnvironmentsCreateOrUpdateResponse>
delete(string, string, string, string, EnvironmentsDeleteOptionalParams)
Deletes the environment.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, environmentName: string, options?: EnvironmentsDeleteOptionalParams): 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.
- environmentName
-
string
The name of the environment.
- options
- EnvironmentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, EnvironmentsGetOptionalParams)
Returns details of the environment.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, environmentName: string, options?: EnvironmentsGetOptionalParams): Promise<EnvironmentsGetResponse>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.
- environmentName
-
string
The name of the environment.
- options
- EnvironmentsGetOptionalParams
The options parameters.
Returns
Promise<EnvironmentsGetResponse>
head(string, string, string, string, EnvironmentsHeadOptionalParams)
Checks if specified environment exists.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, environmentName: string, options?: EnvironmentsHeadOptionalParams): Promise<EnvironmentsHeadResponse>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.
- environmentName
-
string
The name of the environment.
- options
- EnvironmentsHeadOptionalParams
The options parameters.
Returns
Promise<EnvironmentsHeadResponse>
list(string, string, string, EnvironmentsListOptionalParams)
Returns a collection of environments.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: EnvironmentsListOptionalParams): PagedAsyncIterableIterator<Environment, Environment[], PageSettings>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
- EnvironmentsListOptionalParams
The options parameters.