Products interface
Interface representing a Products.
Methods
| begin |
Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. |
| begin |
Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. |
| begin |
Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name' |
| begin |
Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name' |
| begin |
Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. |
| begin |
Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. |
| count |
Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name. |
| get(string, string, string, Products |
Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. |
| list |
List Product resources by Catalog |
| list |
Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name. |
Method Details
beginCreateOrUpdate(string, string, string, Product, ProductsCreateOrUpdateOptionalParams)
Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, productName: string, resource: Product, options?: ProductsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Product>, Product>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- resource
- Product
Resource create parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Product>, Product>>
beginCreateOrUpdateAndWait(string, string, string, Product, ProductsCreateOrUpdateOptionalParams)
Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, resource: Product, options?: ProductsCreateOrUpdateOptionalParams): Promise<Product>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- resource
- Product
Resource create parameters.
The options parameters.
Returns
Promise<Product>
beginDelete(string, string, string, ProductsDeleteOptionalParams)
Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'
function beginDelete(resourceGroupName: string, catalogName: string, productName: string, options?: ProductsDeleteOptionalParams): 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.
- options
- ProductsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ProductsDeleteOptionalParams)
Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'
function beginDeleteAndWait(resourceGroupName: string, catalogName: string, productName: string, options?: ProductsDeleteOptionalParams): 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.
- options
- ProductsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, ProductUpdate, ProductsUpdateOptionalParams)
Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
function beginUpdate(resourceGroupName: string, catalogName: string, productName: string, properties: ProductUpdate, options?: ProductsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Product>, Product>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- properties
- ProductUpdate
The resource properties to be updated.
- options
- ProductsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Product>, Product>>
beginUpdateAndWait(string, string, string, ProductUpdate, ProductsUpdateOptionalParams)
Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
function beginUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, properties: ProductUpdate, options?: ProductsUpdateOptionalParams): Promise<Product>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- properties
- ProductUpdate
The resource properties to be updated.
- options
- ProductsUpdateOptionalParams
The options parameters.
Returns
Promise<Product>
countDevices(string, string, string, ProductsCountDevicesOptionalParams)
Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
function countDevices(resourceGroupName: string, catalogName: string, productName: string, options?: ProductsCountDevicesOptionalParams): Promise<CountDevicesResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
The options parameters.
Returns
Promise<CountDevicesResponse>
get(string, string, string, ProductsGetOptionalParams)
Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
function get(resourceGroupName: string, catalogName: string, productName: string, options?: ProductsGetOptionalParams): Promise<Product>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- productName
-
string
Name of product.
- options
- ProductsGetOptionalParams
The options parameters.
Returns
Promise<Product>
listByCatalog(string, string, ProductsListByCatalogOptionalParams)
List Product resources by Catalog
function listByCatalog(resourceGroupName: string, catalogName: string, options?: ProductsListByCatalogOptionalParams): PagedAsyncIterableIterator<Product, Product[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
The options parameters.
Returns
listGenerateDefaultDeviceGroups(string, string, string, ProductsGenerateDefaultDeviceGroupsOptionalParams)
Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
function listGenerateDefaultDeviceGroups(resourceGroupName: string, catalogName: string, productName: string, options?: ProductsGenerateDefaultDeviceGroupsOptionalParams): PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], 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.
The options parameters.