Deployments interface
Interface representing a Deployments.
Methods
| create |
Creates new or updates existing API deployment. |
| delete(string, string, string, string, string, Deployments |
Deletes API deployment. |
| get(string, string, string, string, string, Deployments |
Returns details of the API deployment. |
| head(string, string, string, string, string, Deployments |
Checks if specified API deployment exists. |
| list(string, string, string, string, Deployments |
Returns a collection of API deployments. |
Method Details
createOrUpdate(string, string, string, string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)
Creates new or updates existing API deployment.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, deploymentName: string, resource: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<DeploymentsCreateOrUpdateResponse>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.
- apiName
-
string
The name of the API.
- deploymentName
-
string
The name of the API deployment.
- resource
- Deployment
Resource create parameters.
The options parameters.
Returns
Promise<DeploymentsCreateOrUpdateResponse>
delete(string, string, string, string, string, DeploymentsDeleteOptionalParams)
Deletes API deployment.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): 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.
- apiName
-
string
The name of the API.
- deploymentName
-
string
The name of the API deployment.
- options
- DeploymentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, DeploymentsGetOptionalParams)
Returns details of the API deployment.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, deploymentName: string, options?: DeploymentsGetOptionalParams): Promise<DeploymentsGetResponse>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.
- apiName
-
string
The name of the API.
- deploymentName
-
string
The name of the API deployment.
- options
- DeploymentsGetOptionalParams
The options parameters.
Returns
Promise<DeploymentsGetResponse>
head(string, string, string, string, string, DeploymentsHeadOptionalParams)
Checks if specified API deployment exists.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, deploymentName: string, options?: DeploymentsHeadOptionalParams): Promise<DeploymentsHeadResponse>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.
- apiName
-
string
The name of the API.
- deploymentName
-
string
The name of the API deployment.
- options
- DeploymentsHeadOptionalParams
The options parameters.
Returns
Promise<DeploymentsHeadResponse>
list(string, string, string, string, DeploymentsListOptionalParams)
Returns a collection of API deployments.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: DeploymentsListOptionalParams): PagedAsyncIterableIterator<Deployment, Deployment[], 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.
- apiName
-
string
The name of the API.
- options
- DeploymentsListOptionalParams
The options parameters.