Deployments interface
Interface representing a Deployments.
Methods
| begin |
Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| begin |
Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| begin |
Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| begin |
Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| get(string, string, string, string, string, Deployments |
Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| list |
List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
Method Details
beginCreateOrUpdate(string, string, string, string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)
Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deploymentName: string, resource: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Deployment>, Deployment>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- deviceGroupName
-
string
Name of device group.
- deploymentName
-
string
Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- resource
- Deployment
Resource create parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Deployment>, Deployment>>
beginCreateOrUpdateAndWait(string, string, string, string, string, Deployment, DeploymentsCreateOrUpdateOptionalParams)
Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deploymentName: string, resource: Deployment, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<Deployment>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- deviceGroupName
-
string
Name of device group.
- deploymentName
-
string
Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- resource
- Deployment
Resource create parameters.
The options parameters.
Returns
Promise<Deployment>
beginDelete(string, string, string, string, string, DeploymentsDeleteOptionalParams)
Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginDelete(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- deviceGroupName
-
string
Name of device group.
- deploymentName
-
string
Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- options
- DeploymentsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, string, DeploymentsDeleteOptionalParams)
Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginDeleteAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- deviceGroupName
-
string
Name of device group.
- deploymentName
-
string
Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- options
- DeploymentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, DeploymentsGetOptionalParams)
Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function get(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deploymentName: string, options?: DeploymentsGetOptionalParams): Promise<Deployment>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- deviceGroupName
-
string
Name of device group.
- deploymentName
-
string
Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- options
- DeploymentsGetOptionalParams
The options parameters.
Returns
Promise<Deployment>
listByDeviceGroup(string, string, string, string, DeploymentsListByDeviceGroupOptionalParams)
List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function listByDeviceGroup(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DeploymentsListByDeviceGroupOptionalParams): PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- deviceGroupName
-
string
Name of device group.
The options parameters.