Python Permission SDK リファレンス¶

このトピックでは、Python Permission SDK の snowflake.permissions モジュールでサポートされている関数のリファレンス情報を提供します。コンシューマーアカウントで権限をリクエストするには、Python Permission SDK を使用する方法については権限および参照をリクエストするユーザーインターフェイスを作成するをご参照ください。

get_application_specifications()¶

アプリに定義されているすべてのアプリ仕様を返します。

署名:

get_application_specifications()

Copy

引数:

この関数は引数を取りません。

戻り値:

各ディクショナリには以下のキー/値のペアが含まれるディクショナリの配列。

{
  "name": "<value>",
  "requested_on": "<value>",
  "type": "<value>",
  "sequence_number": "<value>",
  "status": "<value>",
  "status_upgraded_on": "<value>",
  "label": "<value>",
  "description": "<value>",
  "definition": "<value>",
}

Copy

条件:

name:アプリ仕様の名前。
requested_on:アプリの仕様がリクエストされたときのタイムスタンプ。
type:アプリ仕様のタイプ。サポートされる値はEXTERNAL ACCESSまたはSECURITY INTEGRATIONです。
sequence_number: ID アプリ仕様のバージョンについて。この値は、プロバイダーがアプリ仕様定義を変更するたびに増加されます。
status:アプリ仕様の現在のステータスを指定します。可能な値は次のとおりです。
- APPROVED:コンシューマーはアプリ仕様を承認しました。
- DECLINED:アプリの仕様はコンシューマーの承認または拒否を待っています。
- DECLINED:コンシューマーはアプリの仕様を拒否しました。
- PENDING:アプリの仕様はコンシューマーの承認または拒否を待っています。
status_updated_on:最終ステータス変更時のタイムスタンプ。
label:Snowsightでコンシューマーに表示されるアプリ仕様の名前。
description:Snowsightでコンシューマーに表示されるアプリ仕様の説明。
definition:アプリ仕様定義の一部である値。この列の値は、アプリの仕様の型によって異なります。

get_detailed_reference_asconnections()¶

コンシューマーアカウントのオブジェクトへの参照に関する詳細情報を提供します。

署名:

get_detailed_reference_associations(reference_name: str) -> List[dict]

Copy

引数:

参照の名前を含む文字列値。

戻り値:

辞書の配列を表す JSON オブジェクトを返します各ディクショナリには以下のキー/値のペアが含まれています。

{
  "alias": "<value>",
  "database": "<value>",
  "schema": "<value>",
  "name": "<value>"
}

Copy

条件:

alias:参照のシステム生成エイリアス。
database:オブジェクトがデータベースに存在する場合は、コンシューマーオブジェクトの親データベース名。それ以外の場合は、null。
schema:オブジェクトがスキーマに存在する場合は、コンシューマーオブジェクトの親スキーマ。それ以外の場合は、null。
name:コンシューマーオブジェクトの名前。

get_held_account_privileges()¶

アプリに付与された権限を返します。

署名:

get_held_account_privileges(privilege_names: [str]) -> [str]

Copy

引数:

チェックする権限の名前を含む文字列値の配列。

戻り値:

この関数に渡された権限の配列に基づき、アプリに付与された権限を含む配列を返します。

この関数に渡された権限の配列に基づき、 Snowflake Native App に付与された権限を含む配列を返します。

get_missing_account_privileges()¶

アプリに付与されていない権限を返します。

署名:

get_missing_account_privileges(privilege_names: [str]) -> [str]

Copy

引数:

チェックする権限の名前を含む文字列値の配列。

戻り値:

この関数に渡された権限の配列に基づいて、アプリケーションに付与されて いない 権限を含む配列を返します。

get_reference_asconnections()¶

参照に関連付けられているコンシューマーアカウントのオブジェクトを決定します。

コンシューマーアカウントのオブジェクトへの参照に関する詳細情報を取得するには、get_detailed_reference_asconnections() を使用します。

署名:

get_reference_associations(reference_name: str) -> [str]

Copy

引数:

参照の名前を含む文字列値。

戻り値:

参照にバインドされているコンシューマーアカウント内のオブジェクトの、Snowflakeが生成したエイリアスを含む配列を返します。

is_application_all_mandatory _telemetry_event_definitions_enabled()¶

すべての必須テレメトリーイベント定義がアプリで有効になっているかどうかを確認します。

テレメトリーイベント共有の詳細については、Permissions SDK を使ってイベント定義を確認するをご参照ください。

署名:

is_application_all_mandatory_telemetry_event_definitions_enabled() -> bool

Copy

引数:

この関数は引数を取りません。

戻り値:

すべての必須テレメトリーイベント定義がアプリで有効になっている場合、TRUE を返します。それ以外の場合は FALSE を返します。

is_application_local_to_package()¶

アプリケーションパッケージと同じアカウントにインストールされているかどうかを確認します。

署名:

is_application_local_to_package() -> bool

Copy

引数:

この関数は引数を取りません。

戻り値:

アプリケーションがアプリケーションパッケージと同じアカウントにある場合は TRUE を返します。それ以外の場合は FALSE を返します。

is_external_data_enabled()¶

現在のアプリケーションで外部テーブルとicebergテーブルが使用できるようになっているかどうかを確認します。

署名:

is_external_data_enabled() -> bool

Copy

引数:

この関数は引数を取りません。

戻り値:

アプリが外部テーブルとIcebergテーブルを使用できるようになっている場合は、TRUE を返します。それ以外の場合は FALSE を返します。

request_application_specification_review()¶

Streamlitアプリでコンシューマーがアプリの仕様を確認し、承認、却下する、または何もしないことを可能にするダイアログを開きます。コンシューマーは、アプリの仕様がオプションの場合にのみ拒否することができます。

署名:

request_application_specification_review(spec_names: [str] = None)

Copy

引数:

レビューするアプリ仕様の名前を含む文字列値のオプション配列。このパラメーターが指定されていない場合、ダイアログには、アプリに定義されたすべてのアプリ仕様が表示されます。

戻り値:

このメソッドは何も返しません。

request_aws_api_integration()¶

コンシューマーにAmazon API Gatewayの API 統合をリクエストします。

マニフェストファイルで API の統合を定義する必要があります。他のパラメーターに関する情報の詳細については、CREATE API INTEGRATION をご参照ください。

署名:

request_aws_api_integration(id: str, allowed_prefixes: [str], gateway: AwsGateway, aws_role_arn: str, api_key: str = None, name: str = None, comment: str = None)

Copy

引数:

id:マニフェストファイルで定義されているAPI 統合の名前。
allowed_prefixes:API 統合の許容プレフィックスを含む文字列値の配列。
gateway:API を使用するゲートウェイの型。このパラメーター値は、次のいずれかにする必要があります。
- permissions.AwsGateway.API_GATEWAY
- permissions.AwsGateway.PRIVATE_API_GATEWAY
- permissions.AwsGateway.GOV_API_GATEWAY
- permissions.AwsGateway.GOV_PRIVATE_API_GATEWAY
aws_role_arn:Amazonリソース名（ARN）は、API Gateway は IAM ロールを使用してコンシューマーアカウントにアクセスします。
api_key:API Gateway用のオプション API のキー。
name:API 統合オプションの名前。
comment:comment 統合のオプションのコメントを指定します。

その他の可能なパラメーターに関する情報は CREATE API INTEGRATION をご参照ください。

戻り値:

参照の名前を含む文字列値。

request_azure_api_integration()¶

コンシューマーにAzure API Managementの API 統合をリクエストします。

署名:

request_azure_api_integration(id: str, allowed_prefixes: [str], tenant_id: str, application_id: str, api_key: str = None, name: str = None, comment: str = None)

Copy

引数:

id:マニフェストファイルで定義されているAPI 統合の名前。
allowed_prefixes:API 統合の許容プレフィックスを含む文字列値の配列。
tenant_id:テナント ID 用Azure API 管理。
application_id:Azure API 管理用のアプリケーションID キー。
api_key:Azure API 管理用オプション API キー。
name:API 統合オプションの名前。
comment:comment 統合のオプションのコメントを指定します。

戻り値:

このメソッドは何も返しません。

request_external_data()¶

コンシューマーに外部テーブルとicebergテーブルを使用するための同意をリクエストします。

署名:

request_external_data()

Copy

引数:

この関数は引数を取りません。

戻り値:

このメソッドは何も返しません。

request_google_api_integration()¶

コンシューマーにGoogle Cloud API Gatewayの API 統合をリクエストします。

署名:

request_google_api_integration(id: str, allowed_prefixes: [str], audience: str, name: str = None, comment: str = None, api_key: str = None

Copy

引数:

id:マニフェストファイルで定義されているAPI 統合の名前。
allowed_prefixes:API 統合の許容プレフィックスを含む文字列値の配列。
audience:Google Cloud API Gatewayのオーディエンス。
name:API 統合オプションの名前。
comment:comment 統合のオプションのコメントを指定します。
api_key:Google Cloud API Gateway用のオプション API キー。

戻り値:

このメソッドは何も返しません。

request_account_privileges()¶

権限を含む関数に渡された文字列配列で指定された権限をコンシューマーからリクエストします。指定された権限がマニフェストファイルにリストされている必要があります。

署名:

request_account_privileges(privileges: [str])

Copy

引数:

アプリがリクエストしている権限のリストを含む文字列配列。

戻り値:

このメソッドは何も返しません。

request_reference()¶

関数に渡された文字列で指定された参照をコンシューマーにリクエストします。関数に渡される参照は、マニフェストファイルで定義されている必要があります。

参照に含めることができるオブジェクトとそこでサポートされている権限については、参照に含めることのできるオブジェクトの型および権限をご参照ください。

署名:

request_reference(reference: str)

Copy

引数:

リクエストする参照の名前を含む文字列値。

戻り値:

このメソッドは何も返しません。

Python Permission SDK リファレンス¶

get_application_specifications()¶

get_detailed_reference_asconnections()¶

get_held_account_privileges()¶

get_missing_account_privileges()¶

get_reference_asconnections()¶

is_application_all_mandatory _telemetry_event_definitions_enabled()¶

is_application_authorized_for_telemetry_event_sharing()¶

is_application_local_to_package()¶

is_event_sharing_enabled()¶

is_external_data_enabled()¶

request_application_specification_review()¶

request_aws_api_integration()¶

request_azure_api_integration()¶

request_event_sharing()¶

request_external_data()¶

request_google_api_integration()¶

request_account_privileges()¶

request_reference()¶