sempy_labs.gateway package

Module contents

Binds the specified dataset from the specified workspace to the specified gateway.

This is a wrapper function for the following API: Datasets - Bind To Gateway In Group.

Service Principal Authentication is supported (see here for examples).

Parameters:

dataset (str | uuid.UUID) – The name or ID of the semantic model.
gateway (str | uuid.UUID) – The name or ID of the gateway.
workspace (str | uuid.UUID, default=None) – The workspace name or ID. Defaults to None which resolves to the workspace of the attached lakehouse or if no lakehouse attached, resolves to the workspace of the notebook.
data_source_object_ids (List[uuid.UUID], default=None) – A list of data source object IDs to bind to the gateway.

sempy_labs.gateway.create_vnet_gateway(name: str, capacity: str | UUID, inactivity_minutes_before_sleep: int, number_of_member_gateways: int, subscription_id: str, resource_group: str, virtual_network: str, subnet: str)

Creates a virtual network gateway.

This is a wrapper function for the following API: Gateways - Create Gateway.

Service Principal Authentication is supported (see here for examples).

Parameters:

name (str) – The gateway name.
capacity (str | uuid.UUID) – The capacity name or Id.
inactivity_minutes_before_sleep (int) – The minutes of inactivity before the virtual network gateway goes into auto-sleep. Must be one of the following values: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
number_of_member_gateways (int) – The number of member gateways. A number between 1 and 7.
subscription_id (str) – The subscription ID.
resource_group (str) – The name of the resource group.
virtual_network (str) – The name of the virtual network.
subnet (str) – The name of the subnet.

sempy_labs.gateway.delete_gateway(gateway: str | UUID)

Deletes a gateway.

This is a wrapper function for the following API: Gateways - Delete Gateway.

Service Principal Authentication is supported (see here for examples).

Parameters:: gateway (str | uuid.UUID) – The gateway name or ID.

sempy_labs.gateway.delete_gateway_member(gateway: str | UUID, gateway_member: str | UUID)

Delete gateway member of an on-premises gateway.

This is a wrapper function for the following API: Gateways - Delete Gateway Member.

Service Principal Authentication is supported (see here for examples).

Parameters:

gateway (str | uuid.UUID) – The gateway name or ID.
gateway_member (str | uuid.UUID) – The gateway member name or ID.

sempy_labs.gateway.delete_gateway_role_assignment(gateway: str | UUID, role_assignment_id: UUID)

Delete the specified role assignment for the gateway.

This is a wrapper function for the following API: Gateways - Delete Gateway Role Assignment.

Service Principal Authentication is supported (see here for examples).

Parameters:

gateway (str | uuid.UUID) – The gateway name or ID.
role_assignment_id (uuid.UUID) – The role assignment ID.

sempy_labs.gateway.list_gateway_members(gateway: str | UUID) → DataFrame

Lists gateway members of an on-premises gateway.

This is a wrapper function for the following API: Gateways - List Gateway Members.

Service Principal Authentication is supported (see here for examples).

Parameters:: gateway (str | uuid.UUID) – The gateway name or ID.
Returns:: A pandas dataframe showing a list of gateway members of an on-premises gateway.
Return type:: pandas.DataFrame

sempy_labs.gateway.list_gateway_role_assigments(gateway: str | UUID) → DataFrame

Returns a list of gateway role assignments.

This is a wrapper function for the following API: Gateways - List Gateway Role Assignments.

Service Principal Authentication is supported (see here for examples).

Parameters:: gateway (str | uuid.UUID) – The gateway name or ID.
Returns:: A pandas dataframe showing a list of gateway role assignments.
Return type:: pandas.DataFrame

sempy_labs.gateway.list_gateways() → DataFrame

Returns a list of all gateways the user has permission for, including on-premises, on-premises (personal mode), and virtual network gateways.

This is a wrapper function for the following API: Gateways - List Gateways.

Service Principal Authentication is supported (see here for examples).

Returns:: A pandas dataframe showing a list of all gateways the user has permission for, including on-premises, on-premises (personal mode), and virtual network gateways.
Return type:: pandas.DataFrame

sempy_labs.gateway.update_on_premises_gateway(gateway: str | UUID, allow_cloud_connection_refresh: bool | None = None, allow_custom_connectors: bool | None = None, load_balancing_setting: str | None = None)

Updates an on-premises gateway.

This is a wrapper function for the following API: Gateways - Update Gateway.

Service Principal Authentication is supported (see here for examples).

Parameters:

gateway (str | uuid.UUID) – The gateway name or ID.
allow_cloud_connection_refresh (bool, default=None) – Whether to allow cloud connections to refresh through this on-premises gateway. True - Allow, False - Do not allow.
allow_custom_connectors (bool, default=None) – Whether to allow custom connectors to be used with this on-premises gateway. True - Allow, False - Do not allow.
load_balancing_setting (str, default=None) – The load balancing setting of the on-premises gateway.

sempy_labs.gateway.update_vnet_gateway(gateway: str | UUID, capacity: str | UUID, inactivity_minutes_before_sleep: int | None = None, number_of_member_gateways: int | None = None)

Updates a virtual network gateway.

This is a wrapper function for the following API: Gateways - Update Gateway.

Service Principal Authentication is supported (see here for examples).

Parameters:

gateway (str | uuid.UUID) – The gateway name or ID.
capacity (str | uuid.UUID) – The capacity name or ID.
inactivity_minutes_before_sleep (int, default=None) – The minutes of inactivity before the virtual network gateway goes into auto-sleep. Must be one of the following values: 30, 60, 90, 120, 150, 240, 360, 480, 720, 1440.
number_of_member_gateways (int, default=None) – The number of member gateways. A number between 1 and 7.