databricks-sdk 0.40.0__py3-none-any.whl → 0.42.0__py3-none-any.whl

databricks/sdk/service/settings.py

@@ -14,6 +14,48 @@ _LOG = logging.getLogger('databricks.sdk')
 # all definitions in this file are in alphabetical order
 
 
+@dataclass
+class AccountIpAccessEnable:
+    acct_ip_acl_enable: BooleanMessage
+
+    etag: Optional[str] = None
+    """etag used for versioning. The response is at least as fresh as the eTag provided. This is used
+    for optimistic concurrency control as a way to help prevent simultaneous writes of a setting
+    overwriting each other. It is strongly suggested that systems make use of the etag in the read
+    -> update pattern to perform setting updates in order to avoid race conditions. That is, get an
+    etag from a GET request, and pass it with the PATCH request to identify the setting version you
+    are updating."""
+
+    setting_name: Optional[str] = None
+    """Name of the corresponding setting. This field is populated in the response, but it will not be
+    respected even if it's set in the request body. The setting name in the path parameter will be
+    respected instead. Setting name is required to be 'default' if the setting only has one instance
+    per workspace."""
+
+    def as_dict(self) -> dict:
+        """Serializes the AccountIpAccessEnable into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.acct_ip_acl_enable: body['acct_ip_acl_enable'] = self.acct_ip_acl_enable.as_dict()
+        if self.etag is not None: body['etag'] = self.etag
+        if self.setting_name is not None: body['setting_name'] = self.setting_name
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the AccountIpAccessEnable into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.acct_ip_acl_enable: body['acct_ip_acl_enable'] = self.acct_ip_acl_enable
+        if self.etag is not None: body['etag'] = self.etag
+        if self.setting_name is not None: body['setting_name'] = self.setting_name
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> AccountIpAccessEnable:
+        """Deserializes the AccountIpAccessEnable from a dictionary."""
+        return cls(acct_ip_acl_enable=_from_dict(d, 'acct_ip_acl_enable', BooleanMessage),
+                   etag=d.get('etag', None),
+                   setting_name=d.get('setting_name', None))
+
+
 @dataclass
 class AibiDashboardEmbeddingAccessPolicy:
     access_policy_type: AibiDashboardEmbeddingAccessPolicyAccessPolicyType
@@ -991,6 +1033,36 @@ class DefaultNamespaceSetting:
                    setting_name=d.get('setting_name', None))
 
 
+@dataclass
+class DeleteAccountIpAccessEnableResponse:
+    """The etag is returned."""
+
+    etag: str
+    """etag used for versioning. The response is at least as fresh as the eTag provided. This is used
+    for optimistic concurrency control as a way to help prevent simultaneous writes of a setting
+    overwriting each other. It is strongly suggested that systems make use of the etag in the read
+    -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get
+    an etag from a GET request, and pass it with the DELETE request to identify the rule set version
+    you are deleting."""
+
+    def as_dict(self) -> dict:
+        """Serializes the DeleteAccountIpAccessEnableResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.etag is not None: body['etag'] = self.etag
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the DeleteAccountIpAccessEnableResponse into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.etag is not None: body['etag'] = self.etag
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DeleteAccountIpAccessEnableResponse:
+        """Deserializes the DeleteAccountIpAccessEnableResponse from a dictionary."""
+        return cls(etag=d.get('etag', None))
+
+
 @dataclass
 class DeleteAibiDashboardEmbeddingAccessPolicySettingResponse:
     """The etag is returned."""
@@ -3556,9 +3628,48 @@ class TokenType(Enum):
     """The type of token request. As of now, only `AZURE_ACTIVE_DIRECTORY_TOKEN` is supported."""
 
     ARCLIGHT_AZURE_EXCHANGE_TOKEN = 'ARCLIGHT_AZURE_EXCHANGE_TOKEN'
+    ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY = 'ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY'
     AZURE_ACTIVE_DIRECTORY_TOKEN = 'AZURE_ACTIVE_DIRECTORY_TOKEN'
 
 
+@dataclass
+class UpdateAccountIpAccessEnableRequest:
+    """Details required to update a setting."""
+
+    allow_missing: bool
+    """This should always be set to true for Settings API. Added for AIP compliance."""
+
+    setting: AccountIpAccessEnable
+
+    field_mask: str
+    """Field mask is required to be passed into the PATCH request. Field mask specifies which fields of
+    the setting payload will be updated. The field mask needs to be supplied as single string. To
+    specify multiple fields in the field mask, use comma as the separator (no space)."""
+
+    def as_dict(self) -> dict:
+        """Serializes the UpdateAccountIpAccessEnableRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.allow_missing is not None: body['allow_missing'] = self.allow_missing
+        if self.field_mask is not None: body['field_mask'] = self.field_mask
+        if self.setting: body['setting'] = self.setting.as_dict()
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the UpdateAccountIpAccessEnableRequest into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.allow_missing is not None: body['allow_missing'] = self.allow_missing
+        if self.field_mask is not None: body['field_mask'] = self.field_mask
+        if self.setting: body['setting'] = self.setting
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> UpdateAccountIpAccessEnableRequest:
+        """Deserializes the UpdateAccountIpAccessEnableRequest from a dictionary."""
+        return cls(allow_missing=d.get('allow_missing', None),
+                   field_mask=d.get('field_mask', None),
+                   setting=_from_dict(d, 'setting', AccountIpAccessEnable))
+
+
 @dataclass
 class UpdateAibiDashboardEmbeddingAccessPolicySettingRequest:
     """Details required to update a setting."""
@@ -4391,6 +4502,7 @@ class AccountSettingsAPI:
 
         self._csp_enablement_account = CspEnablementAccountAPI(self._api)
         self._disable_legacy_features = DisableLegacyFeaturesAPI(self._api)
+        self._enable_ip_access_lists = EnableIpAccessListsAPI(self._api)
         self._esm_enablement_account = EsmEnablementAccountAPI(self._api)
         self._personal_compute = PersonalComputeAPI(self._api)
 
@@ -4404,6 +4516,11 @@ class AccountSettingsAPI:
         """Disable legacy features for new Databricks workspaces."""
         return self._disable_legacy_features
 
+    @property
+    def enable_ip_access_lists(self) -> EnableIpAccessListsAPI:
+        """Controls the enforcement of IP access lists for accessing the account console."""
+        return self._enable_ip_access_lists
+
     @property
     def esm_enablement_account(self) -> EsmEnablementAccountAPI:
         """The enhanced security monitoring setting at the account level controls whether to enable the feature on new workspaces."""
@@ -5203,6 +5320,95 @@ class DisableLegacyFeaturesAPI:
         return DisableLegacyFeatures.from_dict(res)
 
 
+class EnableIpAccessListsAPI:
+    """Controls the enforcement of IP access lists for accessing the account console. Allowing you to enable or
+    disable restricted access based on IP addresses."""
+
+    def __init__(self, api_client):
+        self._api = api_client
+
+    def delete(self, *, etag: Optional[str] = None) -> DeleteAccountIpAccessEnableResponse:
+        """Delete the account IP access toggle setting.
+        
+        Reverts the value of the account IP access toggle setting to default (ON)
+        
+        :param etag: str (optional)
+          etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
+          optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting
+          each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern
+          to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET
+          request, and pass it with the DELETE request to identify the rule set version you are deleting.
+        
+        :returns: :class:`DeleteAccountIpAccessEnableResponse`
+        """
+
+        query = {}
+        if etag is not None: query['etag'] = etag
+        headers = {'Accept': 'application/json', }
+
+        res = self._api.do(
+            'DELETE',
+            f'/api/2.0/accounts/{self._api.account_id}/settings/types/acct_ip_acl_enable/names/default',
+            query=query,
+            headers=headers)
+        return DeleteAccountIpAccessEnableResponse.from_dict(res)
+
+    def get(self, *, etag: Optional[str] = None) -> AccountIpAccessEnable:
+        """Get the account IP access toggle setting.
+        
+        Gets the value of the account IP access toggle setting.
+        
+        :param etag: str (optional)
+          etag used for versioning. The response is at least as fresh as the eTag provided. This is used for
+          optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting
+          each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern
+          to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET
+          request, and pass it with the DELETE request to identify the rule set version you are deleting.
+        
+        :returns: :class:`AccountIpAccessEnable`
+        """
+
+        query = {}
+        if etag is not None: query['etag'] = etag
+        headers = {'Accept': 'application/json', }
+
+        res = self._api.do(
+            'GET',
+            f'/api/2.0/accounts/{self._api.account_id}/settings/types/acct_ip_acl_enable/names/default',
+            query=query,
+            headers=headers)
+        return AccountIpAccessEnable.from_dict(res)
+
+    def update(self, allow_missing: bool, setting: AccountIpAccessEnable,
+               field_mask: str) -> AccountIpAccessEnable:
+        """Update the account IP access toggle setting.
+        
+        Updates the value of the account IP access toggle setting.
+        
+        :param allow_missing: bool
+          This should always be set to true for Settings API. Added for AIP compliance.
+        :param setting: :class:`AccountIpAccessEnable`
+        :param field_mask: str
+          Field mask is required to be passed into the PATCH request. Field mask specifies which fields of the
+          setting payload will be updated. The field mask needs to be supplied as single string. To specify
+          multiple fields in the field mask, use comma as the separator (no space).
+        
+        :returns: :class:`AccountIpAccessEnable`
+        """
+        body = {}
+        if allow_missing is not None: body['allow_missing'] = allow_missing
+        if field_mask is not None: body['field_mask'] = field_mask
+        if setting is not None: body['setting'] = setting.as_dict()
+        headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
+        res = self._api.do(
+            'PATCH',
+            f'/api/2.0/accounts/{self._api.account_id}/settings/types/acct_ip_acl_enable/names/default',
+            body=body,
+            headers=headers)
+        return AccountIpAccessEnable.from_dict(res)
+
+
 class EnhancedSecurityMonitoringAPI:
     """Controls whether enhanced security monitoring is enabled for the current workspace. If the compliance
     security profile is enabled, this is automatically enabled. By default, it is disabled. However, if the

databricks/sdk/service/sharing.py

@@ -35,7 +35,8 @@ class CreateProvider:
     """Description about the provider."""
 
     recipient_profile_str: Optional[str] = None
-    """This field is required when the __authentication_type__ is **TOKEN** or not provided."""
+    """This field is required when the __authentication_type__ is **TOKEN**,
+    **OAUTH_CLIENT_CREDENTIALS** or not provided."""
 
     def as_dict(self) -> dict:
         """Serializes the CreateProvider into a dictionary suitable for use as a JSON request body."""
@@ -76,7 +77,7 @@ class CreateRecipient:
     """Description about the recipient."""
 
     data_recipient_global_metastore_id: Optional[str] = None
-    """The global Unity Catalog metastore id provided by the data recipient. This field is required
+    """The global Unity Catalog metastore id provided by the data recipient. This field is only present
     when the __authentication_type__ is **DATABRICKS**. The identifier is of format
     __cloud__:__region__:__metastore-uuid__."""
 
@@ -90,10 +91,12 @@ class CreateRecipient:
     """Username of the recipient owner."""
 
     properties_kvpairs: Optional[SecurablePropertiesKvPairs] = None
-    """Recipient properties as map of string key-value pairs."""
+    """Recipient properties as map of string key-value pairs. When provided in update request, the
+    specified properties will override the existing properties. To add and remove properties, one
+    would need to perform a read-modify-write."""
 
     sharing_code: Optional[str] = None
-    """The one-time sharing code provided by the data recipient. This field is required when the
+    """The one-time sharing code provided by the data recipient. This field is only present when the
     __authentication_type__ is **DATABRICKS**."""
 
     def as_dict(self) -> dict:
@@ -581,7 +584,7 @@ class ProviderInfo:
     data_provider_global_metastore_id: Optional[str] = None
     """The global UC metastore id of the data provider. This field is only present when the
     __authentication_type__ is **DATABRICKS**. The identifier is of format
-    <cloud>:<region>:<metastore-uuid>."""
+    __cloud__:__region__:__metastore-uuid__."""
 
     metastore_id: Optional[str] = None
     """UUID of the provider's UC metastore. This field is only present when the __authentication_type__
@@ -594,10 +597,12 @@ class ProviderInfo:
     """Username of Provider owner."""
 
     recipient_profile: Optional[RecipientProfile] = None
-    """The recipient profile. This field is only present when the authentication_type is `TOKEN`."""
+    """The recipient profile. This field is only present when the authentication_type is `TOKEN` or
+    `OAUTH_CLIENT_CREDENTIALS`."""
 
     recipient_profile_str: Optional[str] = None
-    """This field is only present when the authentication_type is `TOKEN` or not provided."""
+    """This field is required when the __authentication_type__ is **TOKEN**,
+    **OAUTH_CLIENT_CREDENTIALS** or not provided."""
 
     region: Optional[str] = None
     """Cloud region of the provider's UC metastore. This field is only present when the
@@ -607,7 +612,7 @@ class ProviderInfo:
     """Time at which this Provider was created, in epoch milliseconds."""
 
     updated_by: Optional[str] = None
-    """Username of user who last modified Share."""
+    """Username of user who last modified Provider."""
 
     def as_dict(self) -> dict:
         """Serializes the ProviderInfo into a dictionary suitable for use as a JSON request body."""
@@ -704,8 +709,8 @@ class RecipientInfo:
     """The delta sharing authentication type."""
 
     cloud: Optional[str] = None
-    """Cloud vendor of the recipient's Unity Catalog Metstore. This field is only present when the
-    __authentication_type__ is **DATABRICKS**`."""
+    """Cloud vendor of the recipient's Unity Catalog Metastore. This field is only present when the
+    __authentication_type__ is **DATABRICKS**."""
 
     comment: Optional[str] = None
     """Description about the recipient."""
@@ -721,12 +726,15 @@ class RecipientInfo:
     when the __authentication_type__ is **DATABRICKS**. The identifier is of format
     __cloud__:__region__:__metastore-uuid__."""
 
+    expiration_time: Optional[int] = None
+    """Expiration timestamp of the token, in epoch milliseconds."""
+
     ip_access_list: Optional[IpAccessList] = None
     """IP Access List"""
 
     metastore_id: Optional[str] = None
-    """Unique identifier of recipient's Unity Catalog metastore. This field is only present when the
-    __authentication_type__ is **DATABRICKS**"""
+    """Unique identifier of recipient's Unity Catalog Metastore. This field is only present when the
+    __authentication_type__ is **DATABRICKS**."""
 
     name: Optional[str] = None
     """Name of Recipient."""
@@ -735,10 +743,12 @@ class RecipientInfo:
     """Username of the recipient owner."""
 
     properties_kvpairs: Optional[SecurablePropertiesKvPairs] = None
-    """Recipient properties as map of string key-value pairs."""
+    """Recipient properties as map of string key-value pairs. When provided in update request, the
+    specified properties will override the existing properties. To add and remove properties, one
+    would need to perform a read-modify-write."""
 
     region: Optional[str] = None
-    """Cloud region of the recipient's Unity Catalog Metstore. This field is only present when the
+    """Cloud region of the recipient's Unity Catalog Metastore. This field is only present when the
     __authentication_type__ is **DATABRICKS**."""
 
     sharing_code: Optional[str] = None
@@ -766,6 +776,7 @@ class RecipientInfo:
         if self.created_by is not None: body['created_by'] = self.created_by
         if self.data_recipient_global_metastore_id is not None:
             body['data_recipient_global_metastore_id'] = self.data_recipient_global_metastore_id
+        if self.expiration_time is not None: body['expiration_time'] = self.expiration_time
         if self.ip_access_list: body['ip_access_list'] = self.ip_access_list.as_dict()
         if self.metastore_id is not None: body['metastore_id'] = self.metastore_id
         if self.name is not None: body['name'] = self.name
@@ -790,6 +801,7 @@ class RecipientInfo:
         if self.created_by is not None: body['created_by'] = self.created_by
         if self.data_recipient_global_metastore_id is not None:
             body['data_recipient_global_metastore_id'] = self.data_recipient_global_metastore_id
+        if self.expiration_time is not None: body['expiration_time'] = self.expiration_time
         if self.ip_access_list: body['ip_access_list'] = self.ip_access_list
         if self.metastore_id is not None: body['metastore_id'] = self.metastore_id
         if self.name is not None: body['name'] = self.name
@@ -813,6 +825,7 @@ class RecipientInfo:
                    created_at=d.get('created_at', None),
                    created_by=d.get('created_by', None),
                    data_recipient_global_metastore_id=d.get('data_recipient_global_metastore_id', None),
+                   expiration_time=d.get('expiration_time', None),
                    ip_access_list=_from_dict(d, 'ip_access_list', IpAccessList),
                    metastore_id=d.get('metastore_id', None),
                    name=d.get('name', None),
@@ -869,7 +882,7 @@ class RecipientTokenInfo:
     retrieved."""
 
     created_at: Optional[int] = None
-    """Time at which this recipient Token was created, in epoch milliseconds."""
+    """Time at which this recipient token was created, in epoch milliseconds."""
 
     created_by: Optional[str] = None
     """Username of recipient token creator."""
@@ -881,10 +894,10 @@ class RecipientTokenInfo:
     """Unique ID of the recipient token."""
 
     updated_at: Optional[int] = None
-    """Time at which this recipient Token was updated, in epoch milliseconds."""
+    """Time at which this recipient token was updated, in epoch milliseconds."""
 
     updated_by: Optional[str] = None
-    """Username of recipient Token updater."""
+    """Username of recipient token updater."""
 
     def as_dict(self) -> dict:
         """Serializes the RecipientTokenInfo into a dictionary suitable for use as a JSON request body."""
@@ -973,7 +986,7 @@ class RotateRecipientToken:
     expire the existing token immediately, negative number will return an error."""
 
     name: Optional[str] = None
-    """The name of the recipient."""
+    """The name of the Recipient."""
 
     def as_dict(self) -> dict:
         """Serializes the RotateRecipientToken into a dictionary suitable for use as a JSON request body."""
@@ -1023,9 +1036,6 @@ class SecurablePropertiesKvPairs:
         return cls(properties=d.get('properties', None))
 
 
-SecurablePropertiesMap = Dict[str, str]
-
-
 @dataclass
 class ShareInfo:
     comment: Optional[str] = None
@@ -1346,7 +1356,8 @@ class UpdateProvider:
     """Username of Provider owner."""
 
     recipient_profile_str: Optional[str] = None
-    """This field is required when the __authentication_type__ is **TOKEN** or not provided."""
+    """This field is required when the __authentication_type__ is **TOKEN**,
+    **OAUTH_CLIENT_CREDENTIALS** or not provided."""
 
     def as_dict(self) -> dict:
         """Serializes the UpdateProvider into a dictionary suitable for use as a JSON request body."""
@@ -1393,7 +1404,7 @@ class UpdateRecipient:
     """Name of the recipient."""
 
     new_name: Optional[str] = None
-    """New name for the recipient."""
+    """New name for the recipient. ."""
 
     owner: Optional[str] = None
     """Username of the recipient owner."""
@@ -1439,25 +1450,6 @@ class UpdateRecipient:
                    properties_kvpairs=_from_dict(d, 'properties_kvpairs', SecurablePropertiesKvPairs))
 
 
-@dataclass
-class UpdateResponse:
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateResponse into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateResponse into a shallow dictionary of its immediate attributes."""
-        body = {}
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, any]) -> UpdateResponse:
-        """Deserializes the UpdateResponse from a dictionary."""
-        return cls()
-
-
 @dataclass
 class UpdateShare:
     comment: Optional[str] = None
@@ -1583,7 +1575,8 @@ class ProvidersAPI:
         :param comment: str (optional)
           Description about the provider.
         :param recipient_profile_str: str (optional)
-          This field is required when the __authentication_type__ is **TOKEN** or not provided.
+          This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS**
+          or not provided.
         
         :returns: :class:`ProviderInfo`
         """
@@ -1735,7 +1728,8 @@ class ProvidersAPI:
         :param owner: str (optional)
           Username of Provider owner.
         :param recipient_profile_str: str (optional)
-          This field is required when the __authentication_type__ is **TOKEN** or not provided.
+          This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS**
+          or not provided.
         
         :returns: :class:`ProviderInfo`
         """
@@ -1830,7 +1824,7 @@ class RecipientsAPI:
         """Create a share recipient.
         
         Creates a new recipient with the delta sharing authentication type in the metastore. The caller must
-        be a metastore admin or has the **CREATE_RECIPIENT** privilege on the metastore.
+        be a metastore admin or have the **CREATE_RECIPIENT** privilege on the metastore.
         
         :param name: str
           Name of Recipient.
@@ -1839,8 +1833,8 @@ class RecipientsAPI:
         :param comment: str (optional)
           Description about the recipient.
         :param data_recipient_global_metastore_id: str (optional)
-          The global Unity Catalog metastore id provided by the data recipient. This field is required when
-          the __authentication_type__ is **DATABRICKS**. The identifier is of format
+          The global Unity Catalog metastore id provided by the data recipient. This field is only present
+          when the __authentication_type__ is **DATABRICKS**. The identifier is of format
           __cloud__:__region__:__metastore-uuid__.
         :param expiration_time: int (optional)
           Expiration timestamp of the token, in epoch milliseconds.
@@ -1849,9 +1843,11 @@ class RecipientsAPI:
         :param owner: str (optional)
           Username of the recipient owner.
         :param properties_kvpairs: :class:`SecurablePropertiesKvPairs` (optional)
-          Recipient properties as map of string key-value pairs.
+          Recipient properties as map of string key-value pairs. When provided in update request, the
+          specified properties will override the existing properties. To add and remove properties, one would
+          need to perform a read-modify-write.
         :param sharing_code: str (optional)
-          The one-time sharing code provided by the data recipient. This field is required when the
+          The one-time sharing code provided by the data recipient. This field is only present when the
           __authentication_type__ is **DATABRICKS**.
         
         :returns: :class:`RecipientInfo`
@@ -1957,7 +1953,7 @@ class RecipientsAPI:
         The caller must be the owner of the recipient.
         
         :param name: str
-          The name of the recipient.
+          The name of the Recipient.
         :param existing_token_expire_in_seconds: int
           The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time of
           existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to expire
@@ -2021,7 +2017,7 @@ class RecipientsAPI:
                ip_access_list: Optional[IpAccessList] = None,
                new_name: Optional[str] = None,
                owner: Optional[str] = None,
-               properties_kvpairs: Optional[SecurablePropertiesKvPairs] = None):
+               properties_kvpairs: Optional[SecurablePropertiesKvPairs] = None) -> RecipientInfo:
         """Update a share recipient.
         
         Updates an existing recipient in the metastore. The caller must be a metastore admin or the owner of
@@ -2037,7 +2033,7 @@ class RecipientsAPI:
         :param ip_access_list: :class:`IpAccessList` (optional)
           IP Access List
         :param new_name: str (optional)
-          New name for the recipient.
+          New name for the recipient. .
         :param owner: str (optional)
           Username of the recipient owner.
         :param properties_kvpairs: :class:`SecurablePropertiesKvPairs` (optional)
@@ -2045,7 +2041,7 @@ class RecipientsAPI:
           specified properties will override the existing properties. To add and remove properties, one would
           need to perform a read-modify-write.
         
-        
+        :returns: :class:`RecipientInfo`
         """
         body = {}
         if comment is not None: body['comment'] = comment
@@ -2056,7 +2052,8 @@ class RecipientsAPI:
         if properties_kvpairs is not None: body['properties_kvpairs'] = properties_kvpairs.as_dict()
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
 
-        self._api.do('PATCH', f'/api/2.1/unity-catalog/recipients/{name}', body=body, headers=headers)
+        res = self._api.do('PATCH', f'/api/2.1/unity-catalog/recipients/{name}', body=body, headers=headers)
+        return RecipientInfo.from_dict(res)
 
 
 class SharesAPI:

databricks/sdk/useragent.py

@@ -148,4 +148,58 @@ def to_string(alternate_product_info: Optional[Tuple[str, str]] = None,
     base.extend(_extra)
     base.extend(_get_upstream_user_agent_info())
     base.extend(_get_runtime_info())
+    if cicd_provider() != "":
+        base.append((CICD_KEY, cicd_provider()))
     return " ".join(f"{k}/{v}" for k, v in base)
+
+
+# List of CI/CD providers and pairs of envvar/value that are used to detect them.
+_PROVIDERS = {
+    "github": [("GITHUB_ACTIONS", "true")],
+    "gitlab": [("GITLAB_CI", "true")],
+    "jenkins": [("JENKINS_URL", "")],
+    "azure-devops": [("TF_BUILD", "True")],
+    "circle": [("CIRCLECI", "true")],
+    "travis": [("TRAVIS", "true")],
+    "bitbucket": [("BITBUCKET_BUILD_NUMBER", "")],
+    "google-cloud-build": [("PROJECT_ID", ""), ("BUILD_ID", ""), ("PROJECT_NUMBER", ""), ("LOCATION", "")],
+    "aws-code-build": [("CODEBUILD_BUILD_ARN", "")],
+    "tf-cloud": [("TFC_RUN_ID", "")],
+}
+
+# Private variable to store the CI/CD provider. This value is computed at
+# the first invocation of cicd_providers() and is cached for subsequent calls.
+_cicd_provider = None
+
+
+def cicd_provider() -> str:
+    """Return the CI/CD provider if detected, or an empty string otherwise."""
+
+    # This function is safe because (i) assignation are atomic, and (ii)
+    # computating the CI/CD provider is idempotent.
+    global _cicd_provider
+    if _cicd_provider is not None:
+        return _cicd_provider
+
+    providers = []
+    for p in _PROVIDERS:
+        found = True
+        for envvar, value in _PROVIDERS[p]:
+            v = os.getenv(envvar)
+            if v is None or (value != "" and v != value):
+                found = False
+                break
+
+        if found:
+            providers.append(p)
+
+    if len(providers) == 0:
+        _cicd_provider = ""
+    else:
+        # TODO: reconsider what to do if multiple providers are detected.
+        # The current mechanism as the benefit of being deterministic and
+        # robust to ordering changes in _PROVIDERS.
+        providers.sort()
+        _cicd_provider = providers[0]
+
+    return _cicd_provider

databricks/sdk/version.py

@@ -1 +1 @@
-__version__ = '0.40.0'
+__version__ = '0.42.0'