pulumi-google-native-kotlin/com.pulumi.googlenative.apigee.v1.kotlin/Apigee_v1Functions

Apigee_v1Functions

object Apigee_v1Functions

Functions

Link copied to clipboard
suspend fun getAlias(argument: GetAliasPlainArgs): GetAliasResult

Gets an alias.

suspend fun getAlias(argument: suspend GetAliasPlainArgsBuilder.() -> Unit): GetAliasResult
suspend fun getAlias(aliasId: String, environmentId: String, keystoreId: String, organizationId: String): GetAliasResult
Link copied to clipboard
suspend fun getApi(argument: GetApiPlainArgs): GetApiResult

Gets an API proxy including a list of existing revisions.

suspend fun getApi(argument: suspend GetApiPlainArgsBuilder.() -> Unit): GetApiResult
suspend fun getApi(apiId: String, organizationId: String): GetApiResult
Link copied to clipboard
suspend fun getApicategory(argument: GetApicategoryPlainArgs): GetApicategoryResult

Gets a category on the portal.

suspend fun getApicategory(argument: suspend GetApicategoryPlainArgsBuilder.() -> Unit): GetApicategoryResult
suspend fun getApicategory(apicategoryId: String, organizationId: String, siteId: String): GetApicategoryResult
Link copied to clipboard
suspend fun getApiProduct(argument: GetApiProductPlainArgs): GetApiProductResult

Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.

suspend fun getApiProduct(argument: suspend GetApiProductPlainArgsBuilder.() -> Unit): GetApiProductResult
suspend fun getApiProduct(apiproductId: String, organizationId: String): GetApiProductResult
Link copied to clipboard
suspend fun getApp(argument: GetAppPlainArgs): GetAppResult

Returns the details for a developer app.

suspend fun getApp(argument: suspend GetAppPlainArgsBuilder.() -> Unit): GetAppResult
suspend fun getApp(appId: String, developerId: String, entity: String? = null, organizationId: String, query: String? = null): GetAppResult
Link copied to clipboard
suspend fun getArchiveDeployment(argument: GetArchiveDeploymentPlainArgs): GetArchiveDeploymentResult

Gets the specified ArchiveDeployment.

suspend fun getArchiveDeployment(argument: suspend GetArchiveDeploymentPlainArgsBuilder.() -> Unit): GetArchiveDeploymentResult
suspend fun getArchiveDeployment(archiveDeploymentId: String, environmentId: String, organizationId: String): GetArchiveDeploymentResult
Link copied to clipboard
suspend fun getCanaryEvaluation(argument: GetCanaryEvaluationPlainArgs): GetCanaryEvaluationResult

Gets a CanaryEvaluation for an organization.

suspend fun getCanaryEvaluation(argument: suspend GetCanaryEvaluationPlainArgsBuilder.() -> Unit): GetCanaryEvaluationResult
suspend fun getCanaryEvaluation(canaryevaluationId: String, instanceId: String, organizationId: String): GetCanaryEvaluationResult
Link copied to clipboard
suspend fun getDataCollector(argument: GetDataCollectorPlainArgs): GetDataCollectorResult

Gets a data collector.

suspend fun getDataCollector(argument: suspend GetDataCollectorPlainArgsBuilder.() -> Unit): GetDataCollectorResult
suspend fun getDataCollector(datacollectorId: String, organizationId: String): GetDataCollectorResult
Link copied to clipboard
suspend fun getDatastore(argument: GetDatastorePlainArgs): GetDatastoreResult

Get a Datastore

suspend fun getDatastore(argument: suspend GetDatastorePlainArgsBuilder.() -> Unit): GetDatastoreResult
suspend fun getDatastore(datastoreId: String, organizationId: String): GetDatastoreResult
Link copied to clipboard
suspend fun getDebugSession(argument: GetDebugSessionPlainArgs): GetDebugSessionResult

Retrieves a debug session.

suspend fun getDebugSession(argument: suspend GetDebugSessionPlainArgsBuilder.() -> Unit): GetDebugSessionResult
suspend fun getDebugSession(apiId: String, debugsessionId: String, environmentId: String, organizationId: String, revisionId: String): GetDebugSessionResult
Link copied to clipboard
suspend fun getDeveloper(argument: GetDeveloperPlainArgs): GetDeveloperResult

Returns the developer details, including the developer's name, email address, apps, and other information. Note: The response includes only the first 100 developer apps.

suspend fun getDeveloper(argument: suspend GetDeveloperPlainArgsBuilder.() -> Unit): GetDeveloperResult
suspend fun getDeveloper(action: String? = null, developerId: String, organizationId: String): GetDeveloperResult
Link copied to clipboard
suspend fun getEndpointAttachment(argument: GetEndpointAttachmentPlainArgs): GetEndpointAttachmentResult

Gets the endpoint attachment.

suspend fun getEndpointAttachment(argument: suspend GetEndpointAttachmentPlainArgsBuilder.() -> Unit): GetEndpointAttachmentResult
suspend fun getEndpointAttachment(endpointAttachmentId: String, organizationId: String): GetEndpointAttachmentResult
Link copied to clipboard
suspend fun getEntry(argument: GetEntryPlainArgs): GetEntryResult

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

suspend fun getEntry(argument: suspend GetEntryPlainArgsBuilder.() -> Unit): GetEntryResult
suspend fun getEntry(apiId: String, entryId: String, keyvaluemapId: String, organizationId: String): GetEntryResult
Link copied to clipboard
suspend fun getEnvgroup(argument: GetEnvgroupPlainArgs): GetEnvgroupResult

Gets an environment group.

suspend fun getEnvgroup(argument: suspend GetEnvgroupPlainArgsBuilder.() -> Unit): GetEnvgroupResult
suspend fun getEnvgroup(envgroupId: String, organizationId: String): GetEnvgroupResult
Link copied to clipboard
suspend fun getEnvgroupAttachment(argument: GetEnvgroupAttachmentPlainArgs): GetEnvgroupAttachmentResult

Gets an environment group attachment.

suspend fun getEnvgroupAttachment(argument: suspend GetEnvgroupAttachmentPlainArgsBuilder.() -> Unit): GetEnvgroupAttachmentResult
suspend fun getEnvgroupAttachment(attachmentId: String, envgroupId: String, organizationId: String): GetEnvgroupAttachmentResult
Link copied to clipboard
suspend fun getEnvironment(argument: GetEnvironmentPlainArgs): GetEnvironmentResult

Gets environment details.

suspend fun getEnvironment(argument: suspend GetEnvironmentPlainArgsBuilder.() -> Unit): GetEnvironmentResult
suspend fun getEnvironment(environmentId: String, organizationId: String): GetEnvironmentResult
Link copied to clipboard
suspend fun getEnvironmentEntry(argument: GetEnvironmentEntryPlainArgs): GetEnvironmentEntryResult

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

suspend fun getEnvironmentEntry(argument: suspend GetEnvironmentEntryPlainArgsBuilder.() -> Unit): GetEnvironmentEntryResult
suspend fun getEnvironmentEntry(entryId: String, environmentId: String, keyvaluemapId: String, organizationId: String): GetEnvironmentEntryResult
Link copied to clipboard
suspend fun getExport(argument: GetExportPlainArgs): GetExportResult

Gets the details and status of an analytics export job. If the export job is still in progress, its state is set to "running". After the export job has completed successfully, its state is set to "completed". If the export job fails, its state is set to failed.

suspend fun getExport(argument: suspend GetExportPlainArgsBuilder.() -> Unit): GetExportResult
suspend fun getExport(environmentId: String, exportId: String, organizationId: String): GetExportResult
Link copied to clipboard
suspend fun getHostQuery(argument: GetHostQueryPlainArgs): GetHostQueryResult

Get status of a query submitted at host level. If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"

suspend fun getHostQuery(argument: suspend GetHostQueryPlainArgsBuilder.() -> Unit): GetHostQueryResult
suspend fun getHostQuery(hostQueryId: String, organizationId: String): GetHostQueryResult
Link copied to clipboard
suspend fun getHostSecurityReport(argument: GetHostSecurityReportPlainArgs): GetHostSecurityReportResult

Get status of a query submitted at host level. If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"

suspend fun getHostSecurityReport(argument: suspend GetHostSecurityReportPlainArgsBuilder.() -> Unit): GetHostSecurityReportResult
suspend fun getHostSecurityReport(hostSecurityReportId: String, organizationId: String): GetHostSecurityReportResult
Link copied to clipboard
suspend fun getInstance(argument: GetInstancePlainArgs): GetInstanceResult

Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.

suspend fun getInstance(argument: suspend GetInstancePlainArgsBuilder.() -> Unit): GetInstanceResult
suspend fun getInstance(instanceId: String, organizationId: String): GetInstanceResult
Link copied to clipboard
suspend fun getInstanceAttachment(argument: GetInstanceAttachmentPlainArgs): GetInstanceAttachmentResult

Gets an attachment. Note: Not supported for Apigee hybrid.

suspend fun getInstanceAttachment(argument: suspend GetInstanceAttachmentPlainArgsBuilder.() -> Unit): GetInstanceAttachmentResult
suspend fun getInstanceAttachment(attachmentId: String, instanceId: String, organizationId: String): GetInstanceAttachmentResult
Link copied to clipboard
suspend fun getKey(argument: GetKeyPlainArgs): GetKeyResult

Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.

suspend fun getKey(argument: suspend GetKeyPlainArgsBuilder.() -> Unit): GetKeyResult
suspend fun getKey(appId: String, developerId: String, keyId: String, organizationId: String): GetKeyResult
Link copied to clipboard
suspend fun getKeystore(argument: GetKeystorePlainArgs): GetKeystoreResult

Gets a keystore or truststore.

suspend fun getKeystore(argument: suspend GetKeystorePlainArgsBuilder.() -> Unit): GetKeystoreResult
suspend fun getKeystore(environmentId: String, keystoreId: String, organizationId: String): GetKeystoreResult
Link copied to clipboard
suspend fun getNatAddress(argument: GetNatAddressPlainArgs): GetNatAddressResult

Gets the details of a NAT address. Note: Not supported for Apigee hybrid.

suspend fun getNatAddress(argument: suspend GetNatAddressPlainArgsBuilder.() -> Unit): GetNatAddressResult
suspend fun getNatAddress(instanceId: String, natAddressId: String, organizationId: String): GetNatAddressResult
Link copied to clipboard
suspend fun getOrganization(argument: GetOrganizationPlainArgs): GetOrganizationResult

Gets the profile for an Apigee organization. See Understanding organizations.

suspend fun getOrganization(organizationId: String): GetOrganizationResult
suspend fun getOrganization(argument: suspend GetOrganizationPlainArgsBuilder.() -> Unit): GetOrganizationResult
Link copied to clipboard
suspend fun getOrganizationEnvironmentIamPolicy(argument: GetOrganizationEnvironmentIamPolicyPlainArgs): GetOrganizationEnvironmentIamPolicyResult

Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API. You must have the apigee.environments.getIamPolicy permission to call this API.

suspend fun getOrganizationEnvironmentIamPolicy(argument: suspend GetOrganizationEnvironmentIamPolicyPlainArgsBuilder.() -> Unit): GetOrganizationEnvironmentIamPolicyResult
suspend fun getOrganizationEnvironmentIamPolicy(environmentId: String, optionsRequestedPolicyVersion: Int? = null, organizationId: String): GetOrganizationEnvironmentIamPolicyResult
Link copied to clipboard
suspend fun getOverride(argument: GetOverridePlainArgs): GetOverrideResult

Gets a trace configuration override.

suspend fun getOverride(argument: suspend GetOverridePlainArgsBuilder.() -> Unit): GetOverrideResult
suspend fun getOverride(environmentId: String, organizationId: String, overrideId: String): GetOverrideResult
Link copied to clipboard
suspend fun getQuery(argument: GetQueryPlainArgs): GetQueryResult

Get query status If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"

suspend fun getQuery(argument: suspend GetQueryPlainArgsBuilder.() -> Unit): GetQueryResult
suspend fun getQuery(environmentId: String, organizationId: String, queryId: String): GetQueryResult
Link copied to clipboard
suspend fun getRatePlan(argument: GetRatePlanPlainArgs): GetRatePlanResult

Gets the details of a rate plan.

suspend fun getRatePlan(argument: suspend GetRatePlanPlainArgsBuilder.() -> Unit): GetRatePlanResult
suspend fun getRatePlan(apiproductId: String, organizationId: String, rateplanId: String): GetRatePlanResult
Link copied to clipboard
suspend fun getReference(argument: GetReferencePlainArgs): GetReferenceResult

Gets a Reference resource.

suspend fun getReference(argument: suspend GetReferencePlainArgsBuilder.() -> Unit): GetReferenceResult
suspend fun getReference(environmentId: String, organizationId: String, referenceId: String): GetReferenceResult
Link copied to clipboard
suspend fun getReport(argument: GetReportPlainArgs): GetReportResult

Retrieve a custom report definition.

suspend fun getReport(argument: suspend GetReportPlainArgsBuilder.() -> Unit): GetReportResult
suspend fun getReport(organizationId: String, reportId: String): GetReportResult
Link copied to clipboard
suspend fun getResourcefile(argument: GetResourcefilePlainArgs): GetResourcefileResult

Gets the contents of a resource file. For more information about resource files, see Resource files.

suspend fun getResourcefile(argument: suspend GetResourcefilePlainArgsBuilder.() -> Unit): GetResourcefileResult
suspend fun getResourcefile(environmentId: String, name: String, organizationId: String, type: String): GetResourcefileResult
Link copied to clipboard
suspend fun getSecurityReport(argument: GetSecurityReportPlainArgs): GetSecurityReportResult

Get security report status If the query is still in progress, the state is set to "running" After the query has completed successfully, state is set to "completed"

suspend fun getSecurityReport(argument: suspend GetSecurityReportPlainArgsBuilder.() -> Unit): GetSecurityReportResult
suspend fun getSecurityReport(environmentId: String, organizationId: String, securityReportId: String): GetSecurityReportResult
Link copied to clipboard
suspend fun getSharedflow(argument: GetSharedflowPlainArgs): GetSharedflowResult

Gets a shared flow by name, including a list of its revisions.

suspend fun getSharedflow(argument: suspend GetSharedflowPlainArgsBuilder.() -> Unit): GetSharedflowResult
suspend fun getSharedflow(organizationId: String, sharedflowId: String): GetSharedflowResult
Link copied to clipboard
suspend fun getSubscription(argument: GetSubscriptionPlainArgs): GetSubscriptionResult

Gets details for an API product subscription.

suspend fun getSubscription(argument: suspend GetSubscriptionPlainArgsBuilder.() -> Unit): GetSubscriptionResult
suspend fun getSubscription(developerId: String, organizationId: String, subscriptionId: String): GetSubscriptionResult
Link copied to clipboard
suspend fun getTargetServer(argument: GetTargetServerPlainArgs): GetTargetServerResult

Gets a TargetServer resource.

suspend fun getTargetServer(argument: suspend GetTargetServerPlainArgsBuilder.() -> Unit): GetTargetServerResult
suspend fun getTargetServer(environmentId: String, organizationId: String, targetserverId: String): GetTargetServerResult