IotRecommendationsOperations Class

IotRecommendationsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

IotRecommendationsOperations

Constructor

IotRecommendationsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

get	Get IoT recommendation.
get_at_scope	Get IoT recommendation.
list	List IoT recommendations.
list_at_scope	List IoT recommendations.

get

Get IoT recommendation.

async get(resource_group_name: str, solution_name: str, iot_recommendation_id: str, **kwargs) -> azure.mgmt.security.models._models_py3.IotRecommendation

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

solution_name

str

Required

The name of the IoT Security solution.

iot_recommendation_id

str

Required

Id of the recommendation.

cls

callable

A custom type or function that will be passed the direct response

Returns

IotRecommendation, or the result of cls(response)

Return type

IotRecommendation

Exceptions

HttpResponseError

get_at_scope

Get IoT recommendation.

async get_at_scope(scope: str, iot_recommendation_id: str, **kwargs) -> azure.mgmt.security.models._models_py3.IotRecommendationModel

Parameters

scope

str

Required

Scope of the query: Subscription (i.e. /subscriptions/{subscriptionId}) or IoT Hub (i.e. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Devices/iotHubs/{iotHubName}).

iot_recommendation_id

str

Required

Id of the recommendation.

cls

callable

A custom type or function that will be passed the direct response

Returns

IotRecommendationModel, or the result of cls(response)

Return type

IotRecommendationModel

Exceptions

HttpResponseError

list

List IoT recommendations.

list(resource_group_name: str, solution_name: str, recommendation_type: Optional[str] = None, device_id: Optional[str] = None, limit: Optional[int] = None, skip_token: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.security.models._models_py3.IotRecommendationList]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription. The name is case insensitive.

solution_name

str

Required

The name of the IoT Security solution.

recommendation_type

str

default value: None

Filter by recommendation type.

device_id

str

default value: None

Filter by device id.

limit

int

default value: None

Limit the number of items returned in a single page.

skip_token

str

default value: None

Skip token used for pagination.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IotRecommendationList or the result of cls(response)

Return type

AsyncItemPaged[IotRecommendationList]

Exceptions

HttpResponseError

list_at_scope

List IoT recommendations.

list_at_scope(scope: str, recommendation_type: Optional[str] = None, device_id: Optional[str] = None, limit: Optional[int] = None, skip_token: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.security.models._models_py3.IotRecommendationListModel]

Parameters

scope

str

Required

Scope of the query: Subscription (i.e. /subscriptions/{subscriptionId}) or IoT Hub (i.e. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Devices/iotHubs/{iotHubName}).

recommendation_type

str

default value: None

Filter by recommendation type.

device_id

str

default value: None

Filter by device id.

limit

int

default value: None

Limit the number of items returned in a single page.

skip_token

str

default value: None

Skip token used for pagination.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IotRecommendationListModel or the result of cls(response)

Return type

AsyncItemPaged[IotRecommendationListModel]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.security.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\security\\models\\__init__.py'>