ClustersOperations Class
ClustersOperations 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.objectClustersOperations
Constructor
ClustersOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_create_or_update |
Creates a Stream Analytics Cluster or replaces an already existing cluster. |
| begin_delete |
Deletes the specified cluster. |
| begin_update |
Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition. |
| get |
Gets information about the specified cluster. |
| list_by_resource_group |
Lists all of the clusters in the given resource group. |
| list_by_subscription |
Lists all of the clusters in the given subscription. |
| list_streaming_jobs |
Lists all of the streaming jobs in the given cluster. |
begin_create_or_update
Creates a Stream Analytics Cluster or replaces an already existing cluster.
begin_create_or_update(resource_group_name: str, cluster_name: str, cluster: models.Cluster, if_match: Optional[str] = None, if_none_match: Optional[str] = None, **kwargs: Any) -> LROPoller[models.Cluster]Parameters
- cluster
- <xref:stream_analytics_management_client.models.Cluster>
The definition of the cluster that will be used to create a new cluster or replace the existing one.
- if_match
- str
The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
- if_none_match
- str
Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Cluster or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes the specified cluster.
begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_update
Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.
begin_update(resource_group_name: str, cluster_name: str, cluster: models.Cluster, if_match: Optional[str] = None, **kwargs: Any) -> LROPoller[models.Cluster]Parameters
- cluster
- <xref:stream_analytics_management_client.models.Cluster>
The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).
- if_match
- str
The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Cluster or the result of cls(response)
Return type
Exceptions
get
Gets information about the specified cluster.
get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> models.ClusterParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Cluster, or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Lists all of the clusters in the given resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[models.ClusterListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ClusterListResult or the result of cls(response)
Return type
Exceptions
list_by_subscription
Lists all of the clusters in the given subscription.
list_by_subscription(**kwargs: Any) -> Iterable[models.ClusterListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ClusterListResult or the result of cls(response)
Return type
Exceptions
list_streaming_jobs
Lists all of the streaming jobs in the given cluster.
list_streaming_jobs(resource_group_name: str, cluster_name: str, **kwargs: Any) -> Iterable[models.ClusterJobListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ClusterJobListResult or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.streamanalytics.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\streamanalytics\\models\\__init__.py'>Feedback
Submit and view feedback for