azure.mgmt.healthcareapis.operations module¶
-
class
azure.mgmt.healthcareapis.operations.DicomServicesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectDicomServicesOperations 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, workspace_name: str, dicom_service_name: str, dicomservice: ‘_models.DicomService’, **kwargs: Any) → LROPoller[‘_models.DicomService’][source]¶ Creates or updates a DICOM Service resource with the specified parameters.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
workspace_name (str) – The name of workspace resource.
dicom_service_name (str) – The name of DICOM Service resource.
dicomservice (DicomService) – The parameters for creating or updating a Dicom Service 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 DicomService or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, dicom_service_name: str, workspace_name: str, **kwargs: Any) → LROPoller[None][source]¶ Deletes a DICOM Service.
- 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, dicom_service_name: str, workspace_name: str, dicomservice_patch_resource: ‘_models.DicomServicePatchResource’, **kwargs: Any) → LROPoller[‘_models.DicomService’][source]¶ Patch DICOM Service details.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
dicom_service_name (str) – The name of DICOM Service resource.
workspace_name (str) – The name of workspace resource.
dicomservice_patch_resource (DicomServicePatchResource) – The parameters for updating a Dicom Service.
- 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 DicomService or the result of cls(response)
- Return type
- Raises
-
get(resource_group_name: str, workspace_name: str, dicom_service_name: str, **kwargs: Any) → _models.DicomService[source]¶ Gets the properties of the specified DICOM Service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DicomService, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[‘_models.DicomServiceCollection’][source]¶ Lists all DICOM Services for the given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either DicomServiceCollection or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.FhirDestinationsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectFhirDestinationsOperations 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_by_iot_connector(resource_group_name: str, workspace_name: str, iot_connector_name: str, **kwargs: Any) → Iterable[‘_models.IotFhirDestinationCollection’][source]¶ Lists all FHIR destinations for the given IoT Connector.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either IotFhirDestinationCollection or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.FhirServicesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectFhirServicesOperations 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, workspace_name: str, fhir_service_name: str, fhirservice: ‘_models.FhirService’, **kwargs: Any) → LROPoller[‘_models.FhirService’][source]¶ Creates or updates a FHIR Service resource with the specified parameters.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
workspace_name (str) – The name of workspace resource.
fhir_service_name (str) – The name of FHIR Service resource.
fhirservice (FhirService) – The parameters for creating or updating a Fhir Service 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 FhirService or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, fhir_service_name: str, workspace_name: str, **kwargs: Any) → LROPoller[None][source]¶ Deletes a FHIR Service.
- 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, fhir_service_name: str, workspace_name: str, fhirservice_patch_resource: ‘_models.FhirServicePatchResource’, **kwargs: Any) → LROPoller[‘_models.FhirService’][source]¶ Patch FHIR Service details.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
fhir_service_name (str) – The name of FHIR Service resource.
workspace_name (str) – The name of workspace resource.
fhirservice_patch_resource (FhirServicePatchResource) – The parameters for updating a Fhir Service.
- 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 FhirService or the result of cls(response)
- Return type
- Raises
-
get(resource_group_name: str, workspace_name: str, fhir_service_name: str, **kwargs: Any) → _models.FhirService[source]¶ Gets the properties of the specified FHIR Service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
FhirService, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[‘_models.FhirServiceCollection’][source]¶ Lists all FHIR Services for the given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either FhirServiceCollection or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.IotConnectorFhirDestinationOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectIotConnectorFhirDestinationOperations 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, workspace_name: str, iot_connector_name: str, fhir_destination_name: str, iot_fhir_destination: ‘_models.IotFhirDestination’, **kwargs: Any) → LROPoller[‘_models.IotFhirDestination’][source]¶ Creates or updates an IoT Connector FHIR destination resource with the specified parameters.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
workspace_name (str) – The name of workspace resource.
iot_connector_name (str) – The name of IoT Connector resource.
fhir_destination_name (str) – The name of IoT Connector FHIR destination resource.
iot_fhir_destination (IotFhirDestination) – The parameters for creating or updating an IoT Connector FHIR destination 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 IotFhirDestination or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, workspace_name: str, iot_connector_name: str, fhir_destination_name: str, **kwargs: Any) → LROPoller[None][source]¶ Deletes an IoT Connector FHIR destination.
- 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(resource_group_name: str, workspace_name: str, iot_connector_name: str, fhir_destination_name: str, **kwargs: Any) → _models.IotFhirDestination[source]¶ Gets the properties of the specified Iot Connector FHIR destination.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
IotFhirDestination, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.IotConnectorsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectIotConnectorsOperations 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, workspace_name: str, iot_connector_name: str, iot_connector: ‘_models.IotConnector’, **kwargs: Any) → LROPoller[‘_models.IotConnector’][source]¶ Creates or updates an IoT Connector resource with the specified parameters.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
workspace_name (str) – The name of workspace resource.
iot_connector_name (str) – The name of IoT Connector resource.
iot_connector (IotConnector) – The parameters for creating or updating an IoT Connectors 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 IotConnector or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, iot_connector_name: str, workspace_name: str, **kwargs: Any) → LROPoller[None][source]¶ Deletes an IoT Connector.
- 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, iot_connector_name: str, workspace_name: str, iot_connector_patch_resource: ‘_models.IotConnectorPatchResource’, **kwargs: Any) → LROPoller[‘_models.IotConnector’][source]¶ Patch an IoT Connector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
iot_connector_name (str) – The name of IoT Connector resource.
workspace_name (str) – The name of workspace resource.
iot_connector_patch_resource (IotConnectorPatchResource) – The parameters for updating an IoT Connector.
- 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 IotConnector or the result of cls(response)
- Return type
- Raises
-
get(resource_group_name: str, workspace_name: str, iot_connector_name: str, **kwargs: Any) → _models.IotConnector[source]¶ Gets the properties of the specified IoT Connector.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
IotConnector, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[‘_models.IotConnectorCollection’][source]¶ Lists all IoT Connectors for the given workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either IotConnectorCollection or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.OperationResultsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectOperationResultsOperations 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.
-
get(location_name: str, operation_result_id: str, **kwargs: Any) → _models.OperationResultsDescription[source]¶ Get the operation result for a long running operation.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
OperationResultsDescription, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.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.ListOperations’][source]¶ Lists all of the available operations supported by Microsoft Healthcare resource provider.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ListOperations or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.PrivateEndpointConnectionsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectPrivateEndpointConnectionsOperations 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, private_endpoint_connection_name: str, properties: ‘_models.PrivateEndpointConnection’, **kwargs: Any) → LROPoller[‘_models.PrivateEndpointConnectionDescription’][source]¶ Update the state of the specified private endpoint connection associated with the service.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
resource_name (str) – The name of the service instance.
private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource.
properties (PrivateEndpointConnection) – The private endpoint connection properties.
- 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 PrivateEndpointConnectionDescription or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[None][source]¶ Deletes a 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(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → _models.PrivateEndpointConnectionDescription[source]¶ Gets the specified private endpoint connection associated with the service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnectionDescription, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_service(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[‘_models.PrivateEndpointConnectionListResultDescription’][source]¶ Lists all private endpoint connections for a service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PrivateEndpointConnectionListResultDescription or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.PrivateLinkResourcesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectPrivateLinkResourcesOperations 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.
-
get(resource_group_name: str, resource_name: str, group_name: str, **kwargs: Any) → _models.PrivateLinkResourceDescription[source]¶ Gets a private link resource that need to be created for a service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateLinkResourceDescription, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_service(resource_group_name: str, resource_name: str, **kwargs: Any) → _models.PrivateLinkResourceListResultDescription[source]¶ Gets the private link resources that need to be created for a service.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateLinkResourceListResultDescription, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.ServicesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectServicesOperations 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, service_description: ‘_models.ServicesDescription’, **kwargs: Any) → LROPoller[‘_models.ServicesDescription’][source]¶ Create or update the metadata of a service instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
resource_name (str) – The name of the service instance.
service_description (ServicesDescription) – The service instance metadata.
- 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 ServicesDescription or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) → LROPoller[None][source]¶ Delete a service instance.
- 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, service_patch_description: ‘_models.ServicesPatchDescription’, **kwargs: Any) → LROPoller[‘_models.ServicesDescription’][source]¶ Update the metadata of a service instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
resource_name (str) – The name of the service instance.
service_patch_description (ServicesPatchDescription) – The service instance metadata and security metadata.
- 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 ServicesDescription or the result of cls(response)
- Return type
- Raises
-
check_name_availability(check_name_availability_inputs: ‘_models.CheckNameAvailabilityParameters’, **kwargs: Any) → _models.ServicesNameAvailabilityInfo[source]¶ Check if a service instance name is available.
- Parameters
check_name_availability_inputs (CheckNameAvailabilityParameters) – Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServicesNameAvailabilityInfo, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get(resource_group_name: str, resource_name: str, **kwargs: Any) → _models.ServicesDescription[source]¶ Get the metadata of a service instance.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServicesDescription, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list(**kwargs: Any) → Iterable[‘_models.ServicesDescriptionListResult’][source]¶ Get all the service instances 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 ServicesDescriptionListResult 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.ServicesDescriptionListResult’][source]¶ Get all the service instances in a resource group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ServicesDescriptionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶
-
class
azure.mgmt.healthcareapis.operations.WorkspacesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectWorkspacesOperations 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, workspace_name: str, workspace: ‘_models.Workspace’, **kwargs: Any) → LROPoller[‘_models.Workspace’][source]¶ Creates or updates a workspace resource with the specified parameters.
- 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 Workspace or the result of cls(response)
- Return type
- Raises
-
begin_delete(resource_group_name: str, workspace_name: str, **kwargs: Any) → LROPoller[None][source]¶ Deletes a specified workspace.
- 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, workspace_name: str, workspace_patch_resource: ‘_models.WorkspacePatchResource’, **kwargs: Any) → LROPoller[‘_models.Workspace’][source]¶ Patch workspace details.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
workspace_name (str) – The name of workspace resource.
workspace_patch_resource (WorkspacePatchResource) – The parameters for updating a specified workspace.
- 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 Workspace or the result of cls(response)
- Return type
- Raises
-
get(resource_group_name: str, workspace_name: str, **kwargs: Any) → _models.Workspace[source]¶ Gets the properties of the specified workspace.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Workspace, 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.WorkspaceList’][source]¶ Lists all the available workspaces under the specified resource group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the service instance.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WorkspaceList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_subscription(**kwargs: Any) → Iterable[‘_models.WorkspaceList’][source]¶ Lists all the available workspaces under the specified subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WorkspaceList or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models= <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>¶