Referência de Python Permission SDK

Este tópico fornece informações de referência para as funções compatíveis com o módulo snowflake.permissions do Python Permission SDK. Para obter informações sobre como usar o Python Permission SDK para solicitar privilégios na conta do consumidor, consulte Criação de uma interface de usuário para solicitar privilégios e referências.

get_application_specifications()

Retorna todas as especificações do aplicativo definidas para ele.

Assinatura:
get_application_specifications()
Copy
Argumentos:

Essa função não aceita nenhum argumento.

Retornos:

Uma matriz de dicionários, em que cada dicionário contém os seguintes pares de chave/valor:

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

Onde:

  • name: o nome da especificação de aplicativo.

  • requested_on: carimbo de data/hora em que a especificação de aplicativo foi solicitada.

  • type: tipo de especificação de aplicativo. Os valores aceitos são EXTERNAL ACCESS e SECURITY INTEGRATION.

  • sequence_number: ID para uma versão de uma especificação de aplicativo. Este valor é incrementado cada vez que um provedor altera o definição da especificação de aplicativo.

  • status: especifica o status atual da especificação de aplicativo. Os valores possíveis são:

    • APPROVED: o consumidor aprovou a especificação de aplicativo.

    • DECLINED: a especificação de aplicativo está aguardando a aprovação ou recusa do consumidor.

    • DECLINED: o consumidor recusou a especificação de aplicativo.

    • PENDING: a especificação de aplicativo está aguardando a aprovação ou recusa do consumidor.

  • status_updated_on: carimbo de data/hora da última alteração de status.

  • label: nome da especificação de aplicativo exibida ao consumidor no Snowsight.

  • description: descrição da especificação de aplicativo exibida ao consumidor no Snowsight.

  • definition: valores que fazem parte do definição da especificação de aplicativo. Os valores desta coluna dependem do tipo de especificação de aplicativo.

get_detailed_reference_associations()

Fornece informações detalhadas sobre uma referência a um objeto na conta do consumidor.

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

Um valor de string contendo o nome de uma referência.

Retornos:

Retorna um objeto JSON que representa uma matriz de dicionários. Cada dicionário contém os seguintes pares de chave/valor:

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

Onde:

  • alias: o alias gerado pelo sistema para a referência.

  • database: o nome do banco de dados principal do objeto do consumidor, se o objeto residir em um banco de dados. Caso contrário, é nulo.

  • schema: o esquema principal do objeto do consumidor, se o objeto residir em um esquema. Caso contrário, é nulo.

  • name: o nome do objeto do consumidor.

get_held_account_privileges()

Retorna os privilégios que foram concedidos ao aplicativo.

Assinatura:
get_held_account_privileges(privilege_names: [str]) -> [str]
Copy
Argumentos:

Uma matriz de valores de cadeia de caracteres contendo os nomes dos privilégios a serem verificados.

Retornos:

Retorna uma matriz contendo os privilégios que foram concedidos ao aplicativo com base na matriz de privilégios passados para a função.

Retorna uma matriz contendo os privilégios que foram concedidos ao Snowflake Native App com base na matriz de privilégios passados para a função.

get_missing_account_privileges()

Retorna os privilégios que não foram concedidos ao aplicativo.

Assinatura:
get_missing_account_privileges(privilege_names: [str]) -> [str]
Copy
Argumentos:

Uma matriz de valores de cadeia de caracteres contendo os nomes dos privilégios a serem verificados.

Retornos:

Retorna uma matriz de strings contendo os privilégios que não foram concedidos ao aplicativo com base na matriz de privilégios passados para a função.

get_reference_associations()

Determina os objetos na conta do consumidor associados a uma referência.

Para obter informações mais detalhadas sobre referências a objetos na conta do consumidor, use get_detailed_reference_associations().

Assinatura:
get_reference_associations(reference_name: str) -> [str]
Copy
Argumentos:

Um valor de string contendo o nome de uma referência.

Retornos:

Retorna uma matriz contendo aliases de objetos gerados pelo Snowflake na conta do consumidor que estão vinculados à referência.

is_application_all_mandatory _telemetry_event_definitions_enabled()

Verifica se todas as definições de eventos de telemetria obrigatórias estão habilitadas para o aplicativo.

Para obter mais informações sobre compartilhamento de eventos de telemetria, consulte Verificação das definições de evento usando o SDK de permissões.

Assinatura:
is_application_all_mandatory_telemetry_event_definitions_enabled() -> bool
Copy
Argumentos:

Essa função não aceita nenhum argumento.

Retornos:

Retorna TRUE se todas as definições de eventos de telemetria obrigatórias estiverem habilitadas para o aplicativo. Caso contrário, retorna FALSE.

is_application_authorized_for_telemetry_event_sharing()

Verifica se o aplicativo atual está autorizado para compartilhamento de eventos de telemetria.

Para obter mais informações sobre compartilhamento de eventos de telemetria, consulte Verificação das definições de evento usando o SDK de permissões.

Assinatura:
is_application_authorized_for_telemetry_event_sharing() -> bool
Copy
Argumentos:

Essa função não aceita nenhum argumento.

Retornos:

Retorna TRUE se o aplicativo estiver autorizado para compartilhamento de eventos de telemetria. Caso contrário, retorna FALSE.

is_application_local_to_package()

Verifica se ao aplicativo está instalado na mesma conta que o pacote do aplicativo.

Assinatura:
is_application_local_to_package() -> bool
Copy
Argumentos:

Essa função não aceita nenhum argumento.

Retornos:

Retorna TRUE se o aplicativo estiver instalado na mesma conta que o pacote do aplicativo. Caso contrário, retorna FALSE.

is_event_sharing_enabled()

Verifica se o compartilhamento de eventos está habilitado para o aplicativo.

Assinatura:
is_event_sharing_enabled() -> bool
Copy
Argumentos:

Essa função não aceita nenhum argumento.

Retornos:

Retorna TRUE se a propriedade SHARE_EVENTS_WITH_PROVIDER for verdadeira e a conta do consumidor tiver uma tabela de eventos ativa configurada. Caso contrário, retorna FALSE.

is_external_data_enabled()

Verifica se o aplicativo atual está habilitado para usar tabelas externas e Iceberg.

Assinatura:
is_external_data_enabled() -> bool
Copy
Argumentos:

Essa função não aceita nenhum argumento.

Retornos:

Retorna TRUE se o aplicativo estiver habilitado para usar tabelas externas e Iceberg. Caso contrário, retorna FALSE.

request_application_specification_review()

Abre uma caixa de diálogo em um aplicativo Streamlit que permite ao consumidor revisar uma especificação de aplicativo e, em seguida, aprovar, recusar ou não tomar nenhuma ação. Um consumidor só pode recusar uma especificação de aplicativo se for opcional.

Assinatura:
request_application_specification_review(spec_names: [str] = None)
Copy
Argumentos:

Uma matriz opcional de valores de cadeia de caracteres contendo os nomes das especificações de aplicativo a serem revisadas. Se este parâmetro não for especificado, a caixa de diálogo mostrará todas as especificações de aplicativo definidas para o aplicativo.

Retornos:

Este método não retorna um valor.

request_aws_api_integration()

Solicita uma integração de API do consumidor para o Amazon API Gateway.

Você deve definir a integração de API no arquivo de manifesto. Para obter mais informações, consulte CREATE API INTEGRATION para obter informações sobre outros parâmetros.

Assinatura:
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
Argumentos:

  • id: o nome da integração de API definida no arquivo de manifesto.

  • allowed_prefixes: uma matriz de valores de cadeia de caracteres contendo os prefixos permitidos para a integração de API.

  • gateway: o tipo de API Gateway a ser usado. O valor desse parâmetro deve ser um dos exibidos a seguir.

    • permissions.AwsGateway.API_GATEWAY

    • permissions.AwsGateway.PRIVATE_API_GATEWAY

    • permissions.AwsGateway.GOV_API_GATEWAY

    • permissions.AwsGateway.GOV_PRIVATE_API_GATEWAY

  • aws_role_arn: o Nome de Recurso da Amazon (ARN) da função do IAM que o API Gateway usa para acessar a conta do consumidor.

  • api_key: uma chave de API opcional chave para o API Gateway.

  • name: um nome opcional para a integração de API.

  • comment: um comentário opcional para a integração de API.

Consulte CREATE API INTEGRATION para obter informações sobre outros parâmetros possíveis.

Retornos:

Um valor de string contendo o nome de uma referência.

request_azure_api_integration()

Solicita uma integração de API do consumidor para o Azure API Management.

Você deve definir a integração de API no arquivo de manifesto. Para obter mais informações, consulte CREATE API INTEGRATION para obter informações sobre outros parâmetros.

Assinatura:
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
Argumentos:

  • id: o nome da integração de API definida no arquivo de manifesto.

  • allowed_prefixes: uma matriz de valores de cadeia de caracteres contendo os prefixos permitidos para a integração de API.

  • tenant_id: o ID de locatário do Azure API Management.

  • application_id: o ID de aplicativo do Azure API Management.

  • api_key: uma chave de API opcional para o Azure API Management.

  • name: um nome opcional para a integração de API.

  • comment: um comentário opcional para a integração de API.

Retornos:

Este método não retorna um valor.

request_event_sharing()

Abre uma caixa de diálogo em um aplicativo Streamlit que permite que o consumidor compartilhe eventos com o aplicativo.

Assinatura:
request_event_sharing()
Copy
Argumentos:

Essa função não aceita nenhum argumento.

Retornos:

Este método não retorna um valor.

request_external_data()

Solicita o consentimento do consumidor para usar tabelas externas e Iceberg.

Assinatura:
request_external_data()
Copy
Argumentos:

Essa função não aceita nenhum argumento.

Retornos:

Este método não retorna um valor.

request_google_api_integration()

Solicita uma integração de API do consumidor para o Google Cloud API Gateway.

Você deve definir a integração de API no arquivo de manifesto. Para obter mais informações, consulte CREATE API INTEGRATION para obter informações sobre outros parâmetros.

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

  • id: o nome da integração de API definida no arquivo de manifesto.

  • allowed_prefixes: uma matriz de valores de cadeia de caracteres contendo os prefixos permitidos para a integração de API.

  • audience: o público do Google Cloud API Gateway.

  • name: um nome opcional para a integração de API.

  • comment: um comentário opcional para a integração de API.

  • api_key: uma chave de API opcional para o Google Cloud API Gateway.

Retornos:

Este método não retorna um valor.

request_account_privileges()

Solicita privilégios do consumidor especificado por uma matriz de cadeia de caracteres passada para a função que contém os privilégios. Os privilégios especificados devem ser listados no arquivo de manifesto.

Assinatura:
request_account_privileges(privileges: [str])
Copy
Argumentos:

Uma matriz de strings contendo uma lista de privilégios que o aplicativo está solicitando.

Retornos:

Este método não retorna um valor.

request_reference()

Solicita uma referência do consumidor especificado pela cadeia de caracteres passada para a função. A referência passada para a função deve ser definida no arquivo de manifesto.

Consulte Tipos de objeto e privilégios que uma referência pode conter para obter uma lista de objetos que podem ser incluídos em uma referência e os privilégios compatíveis.

Assinatura:
request_reference(reference: str)
Copy
Argumentos:

Um valor de string contendo o nome de uma referência a ser solicitada.

Retornos:

Este método não retorna um valor.

Linguagem: Português