azure.mgmt.signalr.operations module¶
-
class
azure.mgmt.signalr.operations.Operations(client, config, serializer, deserializer)[source]¶ Bases:
objectOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list(**kwargs: Any) → Iterable[‘_models.OperationList’][source]¶ Lists all of the available REST API operations of the Microsoft.SignalRService provider.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either OperationList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.signalr.models' from '/mnt/vss/_work/1/s/sdk/signalr/azure-mgmt-signalr/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/signalr/models/__init__.py'>¶
-
class
azure.mgmt.signalr.operations.SignalROperations(client, config, serializer, deserializer)[source]¶ Bases:
objectSignalROperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_create_or_update(resource_group_name: str, resource_name: str, parameters: ‘_models.SignalRResource’, **kwargs: Any) → LROPoller[‘_models.SignalRResource’][source]¶ Create or update a resource.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resource_name (str) – The name of the resource.
parameters (SignalRResource) – Parameters for the create or update operation.
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 SignalRResource or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) → LROPoller[None][source]¶ Operation to delete a resource.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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
- Raises
-
begin_regenerate_key(resource_group_name: str, resource_name: str, parameters: ‘_models.RegenerateKeyParameters’, **kwargs: Any) → LROPoller[‘_models.SignalRKeys’][source]¶ Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resource_name (str) – The name of the resource.
parameters (RegenerateKeyParameters) – Parameter that describes the Regenerate Key Operation.
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 SignalRKeys or the result of cls(response)
- Return type
- Raises
-
begin_restart(resource_group_name: str, resource_name: str, **kwargs: Any) → LROPoller[None][source]¶ Operation to restart a resource.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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
- Raises
-
begin_update(resource_group_name: str, resource_name: str, parameters: ‘_models.SignalRResource’, **kwargs: Any) → LROPoller[‘_models.SignalRResource’][source]¶ Operation to update an exiting resource.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resource_name (str) – The name of the resource.
parameters (SignalRResource) – Parameters for the update operation.
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 SignalRResource or the result of cls(response)
- Return type
- Raises
-
check_name_availability(location: str, parameters: ‘_models.NameAvailabilityParameters’, **kwargs: Any) → ’_models.NameAvailability’[source]¶ Checks that the resource name is valid and is not already in use.
- Parameters
location (str) – the region.
parameters (NameAvailabilityParameters) – Parameters supplied to the operation.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NameAvailability, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get(resource_group_name: str, resource_name: str, **kwargs: Any) → ’_models.SignalRResource’[source]¶ Get the resource and its properties.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SignalRResource, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.SignalRResourceList’][source]¶ Handles requests to list all resources in a resource group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SignalRResourceList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_subscription(**kwargs: Any) → Iterable[‘_models.SignalRResourceList’][source]¶ Handles requests to list all resources in a subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SignalRResourceList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_keys(resource_group_name: str, resource_name: str, **kwargs: Any) → ’_models.SignalRKeys’[source]¶ Get the access keys of the resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SignalRKeys, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.signalr.models' from '/mnt/vss/_work/1/s/sdk/signalr/azure-mgmt-signalr/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/signalr/models/__init__.py'>¶
-
class
azure.mgmt.signalr.operations.UsagesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectUsagesOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list(location: str, **kwargs: Any) → Iterable[‘_models.SignalRUsageList’][source]¶ List resource usage quotas by location.
- Parameters
location (str) – the location like “eastus”.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SignalRUsageList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.signalr.models' from '/mnt/vss/_work/1/s/sdk/signalr/azure-mgmt-signalr/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/signalr/models/__init__.py'>¶
-
class
azure.mgmt.signalr.operations.SignalRPrivateEndpointConnectionsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectSignalRPrivateEndpointConnectionsOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_delete(private_endpoint_connection_name: str, resource_group_name: str, resource_name: str, **kwargs: Any) → LROPoller[None][source]¶ Delete the specified private endpoint connection.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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
- Raises
-
get(private_endpoint_connection_name: str, resource_group_name: str, resource_name: str, **kwargs: Any) → ’_models.PrivateEndpointConnection’[source]¶ Get the specified private endpoint connection.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[‘_models.PrivateEndpointConnectionList’][source]¶ List private endpoint connections.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PrivateEndpointConnectionList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update(private_endpoint_connection_name: str, resource_group_name: str, resource_name: str, parameters: ‘_models.PrivateEndpointConnection’, **kwargs: Any) → ’_models.PrivateEndpointConnection’[source]¶ Update the state of specified private endpoint connection.
- Parameters
private_endpoint_connection_name (str) – The name of the private endpoint connection.
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resource_name (str) – The name of the resource.
parameters (PrivateEndpointConnection) – The resource of private endpoint and its properties.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.signalr.models' from '/mnt/vss/_work/1/s/sdk/signalr/azure-mgmt-signalr/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/signalr/models/__init__.py'>¶
-
class
azure.mgmt.signalr.operations.SignalRPrivateLinkResourcesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectSignalRPrivateLinkResourcesOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
list(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[‘_models.PrivateLinkResourceList’][source]¶ Get the private link resources that need to be created for a resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PrivateLinkResourceList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.signalr.models' from '/mnt/vss/_work/1/s/sdk/signalr/azure-mgmt-signalr/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/signalr/models/__init__.py'>¶
Bases:
objectSignalRSharedPrivateLinkResourcesOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
Create or update a shared private link resource.
- Parameters
shared_private_link_resource_name (str) – The name of the shared private link resource.
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resource_name (str) – The name of the resource.
parameters (SharedPrivateLinkResource) – The shared private link resource.
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 SharedPrivateLinkResource or the result of cls(response)
- Return type
- Raises
Delete the specified shared private link resource.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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
- Raises
Get the specified shared private link resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SharedPrivateLinkResource, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
List shared private link resources.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SharedPrivateLinkResourceList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError